From ae0b4ca9698bff652bc434206206a66882ed956b Mon Sep 17 00:00:00 2001 From: kqlio67 Date: Fri, 25 Oct 2024 20:23:25 +0300 Subject: feat(README.md): update README with badges and links --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 74e9a0bf..3f8f8976 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ +[![Badge Commits]][Commit Rate] +[![Badge Issues]][Issues] +[![Badge License]][License] +--- ![248433934-7886223b-c1d1-4260-82aa-da5741f303bb](https://github.com/xtekky/gpt4free/assets/98614666/ea012c87-76e0-496a-8ac4-e2de090cc6c9) @@ -6,7 +10,7 @@ --- -Written by [@xtekky](https://github.com/xtekky) +

Written by @xtekky

@@ -53,7 +57,6 @@ Is your site on this repository and you want to take it down? Send an email to t - [ ] 🚧 Improve compatibility and error handling ## 📚 Table of Contents - - [🆕 What's New](#-whats-new) - [📚 Table of Contents](#-table-of-contents) - [🛠ī¸ Getting Started](#-getting-started) @@ -68,7 +71,7 @@ Is your site on this repository and you want to take it down? Send an email to t - [Text Generation](#text-generation) - [Image Generation](#image-generation) - [Web UI](#web-ui) - - [Interference API](docs/interference.md) + - [Interference API](#interference-api) - [Local inference](docs/local.md) - [Configuration](#configuration) - [🚀 Providers and Models](docs/providers-and-models.md) @@ -866,4 +869,7 @@ This project is licensed under (đŸ”ŧ Back to top)

+ -- cgit v1.2.3 From 410668b9a4bd71141e0547adb1a295441b5e2fdb Mon Sep 17 00:00:00 2001 From: kqlio67 Date: Sat, 26 Oct 2024 18:56:51 +0300 Subject: docs(readme): fix typo and update links --- README.md | 63 ++++++++++++++++++++++++++++++++------------------------------- 1 file changed, 32 insertions(+), 31 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3f8f8976..7d009c14 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ > _"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. > [!NOTE] -> Lastet version: [![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) +> Latest version: [![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) > Stats: [![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) ```sh @@ -34,10 +34,11 @@ docker pull hlohaus789/g4f ## 🆕 What's New - **For comprehensive details on new features and updates, please refer to our [Releases](https://github.com/xtekky/gpt4free/releases) page** - - **Installation Guide for Windows (.exe):** đŸ’ģ [#installation-guide-for-windows](#installation-guide-for-windows-exe) + - **Installation Guide for Windows (.exe):** đŸ’ģ [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe) - **Join our Telegram Channel:** 📨 [telegram.me/g4f_channel](https://telegram.me/g4f_channel) - **Join our Discord Group:** đŸ’Ŧ [discord.gg/XfybzPXPH5](https://discord.gg/XfybzPXPH5) + ## đŸ”ģ Site Takedown 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 - [ ] 🚧 Improve compatibility and error handling ## 📚 Table of Contents -- [🆕 What's New](#-whats-new) -- [📚 Table of Contents](#-table-of-contents) -- [🛠ī¸ Getting Started](#-getting-started) - - [Docker Container Guide](#docker-container-guide) - - [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe) - - [Use python](#use-python) - - [Prerequisites](#prerequisites) - - [Install using PyPI package:](#install-using-pypi-package) - - [Install from source:](#install-from-source) - - [Install using Docker:](#install-using-docker) -- [💡 Usage](#-usage) - - [Text Generation](#text-generation) - - [Image Generation](#image-generation) - - [Web UI](#web-ui) - - [Interference API](#interference-api) - - [Local inference](docs/local.md) - - [Configuration](#configuration) -- [🚀 Providers and Models](docs/providers-and-models.md) -- [🔗 Powered by gpt4free](#-powered-by-gpt4free) -- [🤝 Contribute](#-contribute) - - [How do i create a new Provider?](#guide-how-do-i-create-a-new-provider) - - [How can AI help me with writing code?](#guide-how-can-ai-help-me-with-writing-code) -- [🙌 Contributors](#-contributors) -- [Šī¸ Copyright](#-copyright) -- [⭐ Star History](#-star-history) -- [📄 License](#-license) + - [🆕 What's New](#-whats-new) + - [📚 Table of Contents](#-table-of-contents) + - [🛠ī¸ Getting Started](#-getting-started) + - [Docker Container Guide](#docker-container-guide) + - [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe) + - [Use python](#use-python) + - [Prerequisites](#prerequisites) + - [Install using PyPI package](#install-using-pypi-package) + - [Install from source](#install-from-source) + - [Install using Docker](#install-using-docker) + - [💡 Usage](#-usage) + - [Text Generation](#text-generation) + - [Image Generation](#image-generation) + - [Web UI](#web-ui) + - [Interference API](#interference-api) + - [Local Inference](docs/local.md) + - [Configuration](#configuration) + - [🚀 Providers and Models](docs/providers-and-models.md) + - [🔗 Powered by gpt4free](#-powered-by-gpt4free) + - [🤝 Contribute](#-contribute) + - [How do i create a new Provider?](#guide-how-do-i-create-a-new-provider) + - [How can AI help me with writing code?](#guide-how-can-ai-help-me-with-writing-code) + - [🙌 Contributors](#-contributors) + - [Šī¸ Copyright](#-copyright) + - [⭐ Star History](#-star-history) + - [📄 License](#-license) ## 🛠ī¸ Getting Started @@ -126,7 +127,7 @@ To ensure the seamless operation of our application, please follow the instructi 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. -Run the **Webview UI** on other Platfroms: +Run the **Webview UI** on other Platforms: - [/docs/guides/webview](docs/webview.md) @@ -774,10 +775,10 @@ set G4F_PROXY=http://host:port 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. ###### Guide: How do i create a new Provider? - - Read: [/docs/guides/create_provider](docs/guides/create_provider.md) + - Read: [Create Provider Guide](docs/guides/create_provider.md) ###### Guide: How can AI help me with writing code? - - Read: [/docs/guides/help_me](docs/guides/help_me.md) + - Read: [AI Assistance Guide](docs/guides/help_me.md) ## 🙌 Contributors A list of all contributors is available [here](https://github.com/xtekky/gpt4free/graphs/contributors) -- cgit v1.2.3 From a1740936618cf613057c1051ca373d964f068854 Mon Sep 17 00:00:00 2001 From: kqlio67 Date: Mon, 28 Oct 2024 08:00:52 +0200 Subject: Updaate (README.md) --- README.md | 5 ----- 1 file changed, 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7d009c14..1a1d2517 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,3 @@ -[![Badge Commits]][Commit Rate] -[![Badge Issues]][Issues] -[![Badge License]][License] - ---- ![248433934-7886223b-c1d1-4260-82aa-da5741f303bb](https://github.com/xtekky/gpt4free/assets/98614666/ea012c87-76e0-496a-8ac4-e2de090cc6c9) -- cgit v1.2.3