XFE Git
XFE Studio Git
Git 首页 全局搜索
XFE 主站 文档 NuGet
公开
关注 0 Fork 0 Star 1
返回提交历史

XFEstudio/gpt4free

docs(readme): fix typo and update links

410668b9
kqlio67 <kqlio67@users.noreply.github.com>
提交于

代码差异

1 个文件 +32 -31
Modified README.md +32 -31
@@ -21,7 +21,7 @@
21 21 > _"gpt4free"_ serves as a **PoC** (proof of concept), demonstrating the development of an API package with multi-provider requests, with features like timeouts, load balance and flow control.
22 22
23 23 > [!NOTE]
24 > <sup><strong>Lastet version:</strong></sup> [![PyPI version](https://img.shields.io/pypi/v/g4f?color=blue)](https://pypi.org/project/g4f) [![Docker version](https://img.shields.io/docker/v/hlohaus789/g4f?label=docker&color=blue)](https://hub.docker.com/r/hlohaus789/g4f)
24 > <sup><strong>Latest version:</strong></sup> [![PyPI version](https://img.shields.io/pypi/v/g4f?color=blue)](https://pypi.org/project/g4f) [![Docker version](https://img.shields.io/docker/v/hlohaus789/g4f?label=docker&color=blue)](https://hub.docker.com/r/hlohaus789/g4f)
25 25 > <sup><strong>Stats:</strong></sup> [![Downloads](https://static.pepy.tech/badge/g4f)](https://pepy.tech/project/g4f) [![Downloads](https://static.pepy.tech/badge/g4f/month)](https://pepy.tech/project/g4f)
26 26
27 27 ```sh
@@ -34,10 +34,11 @@ docker pull hlohaus789/g4f
34 34
35 35 ## 🆕 What's New
36 36 - **For comprehensive details on new features and updates, please refer to our [Releases](https://github.com/xtekky/gpt4free/releases) page**
37 - **Installation Guide for Windows (.exe):** 💻 [#installation-guide-for-windows](#installation-guide-for-windows-exe)
37 - **Installation Guide for Windows (.exe):** 💻 [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe)
38 38 - **Join our Telegram Channel:** 📨 [telegram.me/g4f_channel](https://telegram.me/g4f_channel)
39 39 - **Join our Discord Group:** 💬 [discord.gg/XfybzPXPH5](https://discord.gg/XfybzPXPH5)
40 40
41
41 42 ## 🔻 Site Takedown
42 43
43 44 Is your site on this repository and you want to take it down? Send an email to takedown@g4f.ai with proof it is yours and it will be removed as fast as possible. To prevent reproduction please secure your API. 😉
@@ -57,32 +58,32 @@ Is your site on this repository and you want to take it down? Send an email to t
57 58 - [ ] 🚧 Improve compatibility and error handling
58 59
59 60 ## 📚 Table of Contents
60 - [🆕 What's New](#-whats-new)
61 - [📚 Table of Contents](#-table-of-contents)
62 - [🛠️ Getting Started](#-getting-started)
63 - [Docker Container Guide](#docker-container-guide)
64 - [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe)
65 - [Use python](#use-python)
66 - [Prerequisites](#prerequisites)
67 - [Install using PyPI package:](#install-using-pypi-package)
68 - [Install from source:](#install-from-source)
69 - [Install using Docker:](#install-using-docker)
70 - [💡 Usage](#-usage)
71 - [Text Generation](#text-generation)
72 - [Image Generation](#image-generation)
73 - [Web UI](#web-ui)
74 - [Interference API](#interference-api)
75 - [Local inference](docs/local.md)
76 - [Configuration](#configuration)
77 - [🚀 Providers and Models](docs/providers-and-models.md)
78 - [🔗 Powered by gpt4free](#-powered-by-gpt4free)
79 - [🤝 Contribute](#-contribute)
80 - [How do i create a new Provider?](#guide-how-do-i-create-a-new-provider)
81 - [How can AI help me with writing code?](#guide-how-can-ai-help-me-with-writing-code)
82 - [🙌 Contributors](#-contributors)
83 - [©️ Copyright](#-copyright)
84 - [⭐ Star History](#-star-history)
85 - [📄 License](#-license)
61 - [🆕 What's New](#-whats-new)
62 - [📚 Table of Contents](#-table-of-contents)
63 - [🛠️ Getting Started](#-getting-started)
64 - [Docker Container Guide](#docker-container-guide)
65 - [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe)
66 - [Use python](#use-python)
67 - [Prerequisites](#prerequisites)
68 - [Install using PyPI package](#install-using-pypi-package)
69 - [Install from source](#install-from-source)
70 - [Install using Docker](#install-using-docker)
71 - [💡 Usage](#-usage)
72 - [Text Generation](#text-generation)
73 - [Image Generation](#image-generation)
74 - [Web UI](#web-ui)
75 - [Interference API](#interference-api)
76 - [Local Inference](docs/local.md)
77 - [Configuration](#configuration)
78 - [🚀 Providers and Models](docs/providers-and-models.md)
79 - [🔗 Powered by gpt4free](#-powered-by-gpt4free)
80 - [🤝 Contribute](#-contribute)
81 - [How do i create a new Provider?](#guide-how-do-i-create-a-new-provider)
82 - [How can AI help me with writing code?](#guide-how-can-ai-help-me-with-writing-code)
83 - [🙌 Contributors](#-contributors)
84 - [©️ Copyright](#-copyright)
85 - [⭐ Star History](#-star-history)
86 - [📄 License](#-license)
86 87
87 88 ## 🛠️ Getting Started
88 89
@@ -126,7 +127,7 @@ To ensure the seamless operation of our application, please follow the instructi
126 127
127 128 By following these steps, you should be able to successfully install and run the application on your Windows system. If you encounter any issues during the installation process, please refer to our Issue Tracker or try to get contact over Discord for assistance.
128 129
129 Run the **Webview UI** on other Platfroms:
130 Run the **Webview UI** on other Platforms:
130 131
131 132 - [/docs/guides/webview](docs/webview.md)
132 133
@@ -774,10 +775,10 @@ set G4F_PROXY=http://host:port
774 775 We welcome contributions from the community. Whether you're adding new providers or features, or simply fixing typos and making small improvements, your input is valued. Creating a pull request is all it takes – our co-pilot will handle the code review process. Once all changes have been addressed, we'll merge the pull request into the main branch and release the updates at a later time.
775 776
776 777 ###### Guide: How do i create a new Provider?
777 - Read: [/docs/guides/create_provider](docs/guides/create_provider.md)
778 - Read: [Create Provider Guide](docs/guides/create_provider.md)
778 779
779 780 ###### Guide: How can AI help me with writing code?
780 - Read: [/docs/guides/help_me](docs/guides/help_me.md)
781 - Read: [AI Assistance Guide](docs/guides/help_me.md)
781 782
782 783 ## 🙌 Contributors
783 784 A list of all contributors is available [here](https://github.com/xtekky/gpt4free/graphs/contributors)