Skip to content

Commit

Permalink
Update project documentation with offline mode example.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Oct 22, 2023
1 parent 12fdc62 commit 0cd6eee
Show file tree
Hide file tree
Showing 3 changed files with 764 additions and 11 deletions.
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ This project is under development with an opinionated setup. It's vital to revie
<br>

<p align="right">
<a href="#top"><b>🔝 Return </b></a>
<a href="#top"><b>Return </b></a>
</p>

---
Expand Down Expand Up @@ -547,13 +547,13 @@ To generate a *README.md* file, use the `readmeai` command in your terminal, alo

To customize the README file generation process, you can modify the project's [configuration file:](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml)

- [*api*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - OpenAI language model API configuration settings.
- [*base_urls*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Base URLs for supported remote repository platforms.
- [*cli*]((https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - CLI option settings used by the *readme-ai* application.)
- [*git*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Default git repository settings used if no repository is provided.
- [*paths*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Directory paths and files used by the *readme-ai* application.
- [*prompts*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Large language model prompts used to generate the README file.
- [*md*](https://github.com/eli64s/readme-ai/blob/main/readmeai/settings/config.toml) - Dynamic Markdown section code templates used to build the README file.
- **api**: OpenAI language model API configuration settings.
- **base_urls**: Base URLs for supported remote repository platforms.
- **cli**: CLI option settings used by the *readme-ai* application.
- **git**: Default git repository settings used if no repository is provided.
- **paths**: Directory paths and files used by the *readme-ai* application.
- **prompts**: Large language model prompts used to generate the README file.
- **md**: Dynamic Markdown section code templates used to build the README file.

---

Expand All @@ -578,12 +578,22 @@ Using `pip`
readmeai --output readme-ai.md --repository https://github.com/eli64s/readme-ai
```

You can also use the `short flags` for the CLI options above. In this example we are naming the output file `readme-ai.md`, setting the repository URL to the *readme-ai* repository, using the `flat-square` badge style, and removing emojis from the README file header names.
You can also use the `short flags` for the CLI options above.

In this example we name the output file `readme-ai.md`, set the repo URL to *readme-ai*, use the `flat-square` badge style, and remove emojis from the README file header names.

```bash
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai -b flat-square -e false
```

Additionally, you can run readme-ai in offline mode, or without an API key! This option is useful for spinning up a baseline README.md file that still contains your project's metadata.

```bash
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai --offline true
```

> Offline mode example [README.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-offline.md)
<br>

Using `docker`
Expand Down Expand Up @@ -679,7 +689,7 @@ bash scripts/test.sh


<p align="right">
<a href="#top"><b>🔝 Return</b></a>
<a href="#top"><b>Return</b></a>
</p>

---
Loading

0 comments on commit 0cd6eee

Please sign in to comment.