diff --git a/README.md b/README.md index 2a0fe86c..e8eaa21e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@

readme-ai-banner-logo

+

Designed for simplicity, customization, and developer productivity.

+

github-actions @@ -182,7 +184,7 @@ Let's take a look at some possible customizations created by readme-ai: > [!IMPORTANT] -> Find detailed guides and tutorials for configuring and customizing your README in the Official Documentation. +> See the [Official Documentation][mkdocs] for more information on customization options and best practices. Next, let's explore the key sections of a typical README generated by readme-ai. @@ -326,7 +328,7 @@ To enable the full functionality of `readmeai`, an account and API key are requi - [**Ollama**](https://github.com/ollama/ollama): Free and open-source. No API key required. - [**Anthropic**](https://www.anthropic.com/): Requires an Anthropic account and API key. - [**Google Gemini**](https://ai.google.dev/tutorials/python_quickstart): Requires a Google Cloud account and API key. -- [**Offline Mode**](https://github.com/eli64s/readme-ai/blob/main/examples/readme-offline.md): Generates a boilerplate README without making API calls. +- [**Offline Mode**](https://github.com/eli64s/readme-ai/blob/main/examples/offline-mode/readme-litellm.md): Generates a README without making API calls. For more information on setting up an API key, refer to the provider's documentation.