Skip to content

Commit

Permalink
‣ Update readme file contents.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Jul 31, 2023
1 parent c9a048f commit 5c6bc51
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,11 +339,16 @@ cd readme-ai

1. Use one of the following methods to install the project dependencies.

> *Pip (PyPI Package)*
> *Pip ([PyPI Package](https://pypi.org/project/readmeai/))*
```sh
pip install readmeai
```

> *Docker*
```sh
docker pull zeroxeli/readme-ai:latest
```

> *Bash*
```sh
bash setup/setup.sh
Expand All @@ -361,11 +366,6 @@ pip install -r requirements.txt
poetry install
```

> *Docker*
```sh
docker pull zeroxeli/readme-ai:latest
```

### 🎮 Using *README-AI*

Use the command-line to provide the OpenAI API key (if not already set) and specify an output path for your README file, along with the path to your local repository or remote code repository. You can also provide the output path in the [configuration file](./conf/conf.toml)
Expand All @@ -378,7 +378,7 @@ Command-Line Arguments:
- `-t` or `--template`: The README template format to use. (coming soon!)
- `l` or `--language`: The language of text written in the README file (coming soon!)

> *Pip (PyPI Package)*
> *Pip ([PyPI Package](https://pypi.org/project/readmeai/))*
```sh
readmeai --api-key "YOUR_API_KEY" --output readme-ai.md --repository https://github.com/eli64s/readme-ai

Expand All @@ -387,6 +387,14 @@ export OPENAI_API_KEY="YOUR_API_KEY"
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai
```

> *Docker*
```sh
docker run -it \
-e OPENAI_API_KEY="YOUR_API_KEY" \
-v "$(pwd)":/app zeroxeli/readme-ai:latest \
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai
```

> *Conda*
```sh
conda activate readmeai
Expand All @@ -401,14 +409,6 @@ export OPENAI_API_KEY="YOUR_API_KEY"
poetry run python readmeai/main.py -o readme-ai.md -r https://github.com/eli64s/readme-ai
```

> *Docker*
```sh
docker run -it \
-e OPENAI_API_KEY="YOUR_API_KEY" \
-v "$(pwd)":/app zeroxeli/readme-ai:latest \
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai
```

### 🧪 Running Tests

To run the unit-tests for README-AI, use the following command.
Expand Down

0 comments on commit 5c6bc51

Please sign in to comment.