diff --git a/README.md b/README.md index d932b72..440b884 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,44 @@ HermeneisGPT is a framework to translate hacking messages from Russian to English using LLM models. -![image](https://github.com/stratosphereips/hermeneisGPT/assets/2458879/c1eac777-f760-4523-b7df-9860b62a0b07) +image +
+

Expand for Installation Instructions

+To configure and run the tool, follow the next steps: +```bash +:~$ git clone https://github.com/stratosphereips/hermeneisGPT.git +:~$ +:~$ cd hermeneisGPT +:~$ +:~$ python3 -m pip install -r requirements.txt +:~$ +:~$ cp env_EXAMPLE .env +:~$ +:~$ # Edit the .env file to add your OpenAI API Key +:~$ vim .env +``` +
-# Installation +
+

Expand for Execution Instructions

-1. Install the requirements: `python3 -m pip install -r requirements.txt` -2. Create .env file with OpenAI API Key: - - `cp env_EXAMPLE .env` - - `vim .env` -5. Run the tool: `python3 hermeneisGPT.py --help` +Run hermeneisGPT help: + +```bash +python3 hermeneisGPT.py --help +``` + +Run hermeneisGPT in manual interactive mode: + +```bash +python3 hermeneisGPT.py -m manual +``` + +Run hermeneisGPT in automatic mode using the example SQLite DB: +```bash +python3 hermeneisGPT.py -m auto-sqlite --channel_name noname05716 --sqlite_db assets/sample.sqlite -d +``` +