From 99c49079092dfa32f87e1f77a9b0e58afd01dcaa Mon Sep 17 00:00:00 2001 From: Eli Date: Sun, 10 Nov 2024 15:05:04 -0600 Subject: [PATCH] Update project logo. --- README.md | 91 ++++++++++++++----- .../assets/svg/readme-ai-logo-gradient.svg | 24 ++++- 2 files changed, 89 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index bb7ea641..f49d704d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- readme-ai-banner-logo + readme-ai-banner-logo

@@ -73,8 +73,8 @@ This tool is designed to streamline the documentation process for developers, sa - **🚀 Automated Documentation:** Generate comprehensive README files automatically from your codebase. - **🎨 Customizable Output:** Tailor the styling, formatting, badges, header designs, and more preferences. +- **🤖 Flexible Backends:** Seamlessly integrate with `OpenAI`, `Ollama`, `Anthropic`, `Google Gemini`. - **🌐 Language Agnostic:** Compatible with a wide range of programming languages and project types. -- **🤖 Multi-LLM Support:** Current support for `OpenAI`, `Ollama`, `Anthropic`, `Google Gemini`. - **📑 Offline Mode:** Create boilerplate README files offline, without any external API calls. - **📝 Best Practices:** Ensures clean, professional documentation, adhering to markdown best practices. @@ -279,7 +279,7 @@ Next, let's explore the key sections of a typical README generated by readme-ai. Additional Sections
-

◎ Project Roadmap, Contributing Guidelines, License, and Acknowledgements are included by default. +

◎ Roadmap, Contributing Guidelines, License, and Acknowledgements are included by default.

@@ -295,29 +295,35 @@ Next, let's explore the key sections of a typical README generated by readme-ai. ### System Requirements -- **Python**: `3.9+` -- **Package Manager/Container**: `pip`, `pipx`, `uv`, or `docker`. +- **Python Version**: `3.9` or higher +- **Package Management/Conainter Runtime**: Choose one of the following: + - [`pip`][pip]: Python's default package installer, recommended for most users. + - [`pipx`][pipx]: Install and run readme-ai in an isolated environment. + - [`uv`][uv]: Fastest way to install readme-ai with a single command. + - [`docker`][docker]: Run readme-ai in a containerized environment. -### Supported Sources +## Supported Repository Sources -The following git hosting services are supported for source code retrieval, along with your local file system: +The `readmeai` CLI can retrieve source code from the following Git hosting services or your local file system: -- [**GitHub**](https://github.com/) -- [**GitLab**](https://gitlab.com/) -- [**Bitbucket**](https://bitbucket.org/) -- [**File System**](https://en.wikipedia.org/wiki/File_system) +| Platform | Description | Resource | +| :------- | :---------- | :--- | +| File System | Access repositories on your machine | [Learn more][file-system] | +| GitHub | World's largest code hosting platform | [GitHub.com][github] | +| GitLab | Complete DevOps platform | [GitLab.com][gitlab] | +| Bitbucket | Atlassian's Git solution | [Bitbucket.org][bitbucket] | -### Supported LLM APIs +## Supported LLM API Providers -To enable the full functionality of `readmeai`, an account and API key are required for one of the following providers: +To unlock the full potential of `readmeai`, you'll need an account and API key from one of the providers below: -- [**OpenAI**](https://platform.openai.com/docs/quickstart/account-setup): Recommended for general use. Requires an OpenAI account and API key. -- [**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/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. +| Provider | Description | Resource | +|----------|-------------|-------| +| OpenAI | Recommended for general use | [OpenAI Developer quickstart][openai] | +| Anthropic | Advanced language models | [Anthropic Developer docs][anthropic] | +| Google Gemini | Google's multimodal AI model | [Gemini API quickstart][gemini] | +| Ollama | Free and open-source (No API key required) | [Ollama GitHub repository][ollama] | +| Offline Mode | Run `readmeai` without a LLM API | [Example offline mode README][offline-mode] | ## ⚙️ Installation @@ -330,6 +336,8 @@ Choose your preferred installation method: ###  Pip +Recommended method for most users: + ```sh ❯ pip install readmeai ``` @@ -341,12 +349,24 @@ Choose your preferred installation method: ###  Pipx +Use [pipx](https://pipx.pypa.io/stable/installation/) to use `readmeai` in an isolated environment, ensuring no dependency conflicts with other Python projects: + ```sh ❯ pipx install readmeai ``` + + +###  Uv + +Use [uv](https://github.com/astral-sh/uv) for the fastest way to install `readmeai` with a single command: + +```sh +❯ uv tool install readmeai +``` [mkdocs]: https://eli64s.github.io/readme-ai "Official Documentation" + +[pip]: https://pip.pypa.io/en/stable/ "pip" +[pipx]: https://pipx.pypa.io/stable/ "pipx" +[uv]: https://docs.astral.sh/uv/ "uv" +[docker]: https://docs.docker.com/ "docker" + + +[file-system]: https://en.wikipedia.org/wiki/File_system "Learn more" +[github]: https://github.com/ "GitHub.com" +[gitlab]: https://gitlab.com/ "GitLab.com" +[bitbucket]: https://bitbucket.org/ "Bitbucket.org" + + +[openai]: https://platform.openai.com/docs/quickstart/account-setup: "OpenAI Developer quickstart" +[anthropic]: https://docs.anthropic.com/en/home "Anthropic Developer docs" +[gemini]: https://ai.google.dev/tutorials/python_quickstart "Gemini API quickstart" +[ollama]: https://github.com/ollama/ollama "Ollama GitHub repository" + [contributing]: https://github.com/eli64s/readme-ai/blob/main/CONTRIBUTING.md [issues]: https://github.com/eli64s/readme-ai/issues [discussions]: https://github.com/eli64s/readme-ai/discussions [license]: https://github.com/eli64s/readme-ai/blob/main/LICENSE +[pulls]: https://github.com/eli64s/readme-ai/pulls) "submit a pull request" [default]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-ai.md "readme-python.md" diff --git a/docs/docs/assets/svg/readme-ai-logo-gradient.svg b/docs/docs/assets/svg/readme-ai-logo-gradient.svg index fb2e8ece..35e7cea4 100644 --- a/docs/docs/assets/svg/readme-ai-logo-gradient.svg +++ b/docs/docs/assets/svg/readme-ai-logo-gradient.svg @@ -1,14 +1,32 @@ - + + + + + M + - README-AI - + + README-AI + + + + + Your AI-Powered Documentation Assistant + + \ No newline at end of file