summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md41
1 files changed, 21 insertions, 20 deletions
diff --git a/README.md b/README.md
index 82e08de5..baf2fb3f 100644
--- a/README.md
+++ b/README.md
@@ -22,36 +22,37 @@ docker pull hlohaus789/g4f
## 📚 Table of Contents
-- [🆕 What's New](#-whats-new)
+- [🆕 What's New](#-what-s-new)
- [📚 Table of Contents](#-table-of-contents)
-- [🛠ī¸ Getting Started](#ī¸-getting-started)
- - [Prerequisites:](#prerequisites)
- - [Setting up the project:](#setting-up-the-project)
+- [🛠ī¸ Getting Started](#-getting-started)
+ + [Docker container](#docker-container)
+ - [Quick start](#quick-start)
+ + [Use python package](#use-python-package)
+ - [Prerequisites](#prerequisites)
- [Install using pypi](#install-using-pypi)
- - [or](#or)
- - [Setting up with Docker:](#setting-up-with-docker)
+ + [Docker for Developers](#docker-for-developers)
- [💡 Usage](#-usage)
- - [The `g4f` Package](#the-g4f-package)
- - [ChatCompletion](#chatcompletion)
+ * [The `g4f` Package](#the-g4f-package)
+ + [ChatCompletion](#chatcompletion)
- [Completion](#completion)
- [Providers](#providers)
- - [Cookies Required](#cookies-required)
+ - [Using Browser](#using-browser)
- [Async Support](#async-support)
- [Proxy and Timeout Support](#proxy-and-timeout-support)
- - [Interference openai-proxy API (Use with openai python package)](#interference-openai-proxy-api-use-with-openai-python-package)
- - [Run interference API from PyPi package](#run-interference-api-from-pypi-package)
- - [Run interference API from repo](#run-interference-api-from-repo)
+ * [Interference openai-proxy API](#interference-openai-proxy-api-use-with-openai-python-package-)
+ + [Run interference API from PyPi package](#run-interference-api-from-pypi-package)
+ + [Run interference API from repo](#run-interference-api-from-repo)
- [🚀 Providers and Models](#-providers-and-models)
- - [GPT-4](#gpt-4)
- - [GPT-3.5](#gpt-35)
- - [Other](#other)
- - [Models](#models)
+ * [GPT-4](#gpt-4)
+ * [GPT-3.5](#gpt-35)
+ * [Other](#other)
+ * [Models](#models)
- [🔗 Related GPT4Free Projects](#-related-gpt4free-projects)
- [🤝 Contribute](#-contribute)
- - [Create Provider with AI Tool](#create-provider-with-ai-tool)
- - [Create Provider](#create-provider)
+ + [Create Provider with AI Tool](#create-provider-with-ai-tool)
+ + [Create Provider](#create-provider)
- [🙌 Contributors](#-contributors)
-- [Šī¸ Copyright](#ī¸-copyright)
+- [Šī¸ Copyright](#-copyright)
- [⭐ Star History](#-star-history)
- [📄 License](#-license)
@@ -70,7 +71,7 @@ docker run -p 8080:80 -p 1337:1337 -p 7900:7900 --shm-size="2g" hlohaus789/g4f:l
```
3. Open the included client on: [http://localhost:8080/chat/](http://localhost:8080/chat/)
or set the api base in your client to: [http://localhost:1337/v1](http://localhost:1337/v1)
-4. (Optional) If you need to log in to a provider, you can open the desktop in the container here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret.
+4. (Optional) If you need to log in to a provider, you can view the desktop from the container here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret.
#### Use python package