Skip to content

Commit 0cd6eee

Browse files
committed
Update project documentation with offline mode example.
1 parent 12fdc62 commit 0cd6eee

File tree

3 files changed

+764
-11
lines changed

3 files changed

+764
-11
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ This project is under development with an opinionated setup. It's vital to revie
377377
<br>
378378

379379
<p align="right">
380-
<a href="#top"><b>🔝 Return </b></a>
380+
<a href="#top"><b>Return </b></a>
381381
</p>
382382

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

548548
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)
549549

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

558558
---
559559

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

581-
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.
581+
You can also use the `short flags` for the CLI options above.
582+
583+
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.
582584

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

589+
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.
590+
591+
```bash
592+
readmeai -o readme-ai.md -r https://github.com/eli64s/readme-ai --offline true
593+
```
594+
595+
> Offline mode example [README.md](https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-offline.md)
596+
587597
<br>
588598

589599
Using `docker`
@@ -679,7 +689,7 @@ bash scripts/test.sh
679689

680690

681691
<p align="right">
682-
<a href="#top"><b>🔝 Return</b></a>
692+
<a href="#top"><b>Return</b></a>
683693
</p>
684694

685695
---

0 commit comments

Comments
 (0)