Skip to content

Commit

Permalink
Fix broken links in readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Oct 27, 2024
1 parent 8c5e41f commit 5ff342f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<p align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-animated.svg" alt="readme-ai-banner-logo" width="100%">
</p>

<p align="center">
<em>Designed for simplicity, customization, and developer productivity.</em>
</p>

<p align="center">
<a href="https://github.com/eli64s/readme-ai/actions">
<img src="https://img.shields.io/github/actions/workflow/status/eli64s/readme-ai/release-pipeline.yml?logo=githubactions&label=CICD&logoColor=white&color=4169E1" alt="github-actions">
Expand Down Expand Up @@ -182,7 +184,7 @@ Let's take a look at some possible customizations created by readme-ai:
</table>

> [!IMPORTANT]
> Find detailed guides and tutorials for configuring and customizing your README in the <a href="https://eli64s.github.io/readme-ai/configuration/#cli-options">Official Documentation</a>.
> 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.

Expand Down Expand Up @@ -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.

<sub>For more information on setting up an API key, refer to the provider's documentation.</sub>

Expand Down

0 comments on commit 5ff342f

Please sign in to comment.