From 77697be33381a01350d0818ff069469faea2f4ac Mon Sep 17 00:00:00 2001
From: Arran Hobson Sayers <ahobsonsayers@gmail.com>
Date: Thu, 12 Oct 2023 02:35:11 +0100
Subject: Unify g4f tools into one CLI

---
 README.md | 43 ++++++++++++++++++++++++++++++++-----------
 1 file changed, 32 insertions(+), 11 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 973804d9..2a79c686 100644
--- a/README.md
+++ b/README.md
@@ -7,18 +7,39 @@ By using this repository or any code related to it, you agree to the [legal noti
 pip install -U g4f
 ```
 
+or if you just want to use the gui or interference api, install with [pipx](https://pypa.github.io/pipx/)
+
+```sh
+pipx install g4f
+```
+
 ## New features
 - Telegram Channel: https://t.me/g4f_channel
 - g4f GUI is back !!:   
 Install g4f with pip and then run:
-```py
+
+```sh
+g4f gui
+```
+
+or 
+
+```sh
 python -m g4f.gui.run
 ```
+
 preview:
 
 <img width="1470" alt="image" src="https://github.com/xtekky/gpt4free/assets/98614666/57ad818a-a0dd-4eae-83e1-3fff848ae040">
 
-- run interference from pypi package:
+- run interference api from pypi package:
+
+```sh
+g4f api
+```
+
+or
+
 ```py
 python -m g4f.interference.run
 ```
@@ -33,7 +54,7 @@ python -m g4f.interference.run
 - [Usage](#usage)
   - [The `g4f` Package](#the-g4f-package)
   - [interference openai-proxy api (use with openai python package)](#interference-openai-proxy-api-use-with-openai-python-package)
-- [Providers](#models)
+- [Models](#models)
   - [gpt-3.5 / gpt-4](#gpt-35--gpt-4)
   - [Other Models](#other-models)
 - [Related gpt4free projects](#related-gpt4free-projects)
@@ -319,26 +340,26 @@ print(f"Result:", response)
 
 ### interference openai-proxy api (use with openai python package)
 
-#### run interference from pypi package:
+#### run interference api from pypi package:
 ```py
-from g4f.interference import run_interference
+from g4f.api import run_api
 
-run_interference()
+run_api()
 ```
 
-#### run interference from repo:
+#### run interference api from repo:
 If you want to use the embedding function, you need to get a huggingface token. You can get one at https://huggingface.co/settings/tokens make sure your role is set to write. If you have your token, just use it instead of the OpenAI api-key.
 
-get requirements:
+run server:
 
 ```sh
-pip install -r etc/interference/requirements.txt
+g4f api
 ```
 
-run server:
+or
 
 ```sh
-python3 -m etc/interference.app
+python -m g4f.api
 ```
 
 ```py
-- 
cgit v1.2.3


From 5f7f7feacc1eb164723665c7edbd5e0350938372 Mon Sep 17 00:00:00 2001
From: Tekky <98614666+xtekky@users.noreply.github.com>
Date: Thu, 12 Oct 2023 14:32:13 +0100
Subject: change "Models" to "Providers"

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 2a79c686..2f7e6532 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@ python -m g4f.interference.run
 - [Usage](#usage)
   - [The `g4f` Package](#the-g4f-package)
   - [interference openai-proxy api (use with openai python package)](#interference-openai-proxy-api-use-with-openai-python-package)
-- [Models](#models)
+- [Providers](#models)
   - [gpt-3.5 / gpt-4](#gpt-35--gpt-4)
   - [Other Models](#other-models)
 - [Related gpt4free projects](#related-gpt4free-projects)
-- 
cgit v1.2.3