Skip to content

Commit

Permalink
Update project logo.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Nov 10, 2024
1 parent 98f887a commit 99c4907
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 26 deletions.
91 changes: 68 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-cosmic.svg" alt="readme-ai-banner-logo" width="100%">
<img src="https://raw.githubusercontent.com/eli64s/readme-ai/main/docs/docs/assets/svg/readme-ai-logo-gradient.svg" alt="readme-ai-banner-logo" width="60%">
</p>

<p align="center">
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -279,7 +279,7 @@ Next, let's explore the key sections of a typical README generated by readme-ai.
</tr>
<tr>
<td><b>Additional Sections</b><br>
<p>◎ <code>Project Roadmap</code>, <code>Contributing Guidelines</code>, <code>License</code>, and <code>Acknowledgements</code> are included by default.
<p>◎ <code>Roadmap</code>, <code>Contributing Guidelines</code>, <code>License</code>, and <code>Acknowledgements</code> are included by default.
</p>
</td>
</tr>
Expand All @@ -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.

<sub>For more information on setting up an API key, refer to the provider's documentation.</sub>
| 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

Expand All @@ -330,6 +336,8 @@ Choose your preferred installation method:

### <img width="2%" src="https://raw.githubusercontent.com/eli64s/readme-ai/5ba3f704de2795e32f9fdb67e350caca87975a66/docs/docs/assets/svg/python.svg">&emsp13;Pip

Recommended method for most users:

```sh
❯ pip install readmeai
```
Expand All @@ -341,12 +349,24 @@ Choose your preferred installation method:

### <img width="2%" src="https://raw.githubusercontent.com/eli64s/readme-ai/5ba3f704de2795e32f9fdb67e350caca87975a66/docs/docs/assets/svg/pipx.svg">&emsp13;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
```

<!--
> [!TIP]
> <sub>Using [pipx](https://pipx.pypa.io/stable/installation/) allows you to install and run Python command-line applications in isolated environments, which helps prevent dependency conflicts with other Python projects.</sub>
-->

### <img width="2%" src="https://raw.githubusercontent.com/eli64s/readme-ai/5ba3f704de2795e32f9fdb67e350caca87975a66/docs/docs/assets/svg/astral.svg">&emsp13;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
```

<!--
#### Using `docker`
Expand All @@ -355,7 +375,7 @@ Choose your preferred installation method:

### <img width="2%" src="https://raw.githubusercontent.com/eli64s/readme-ai/3052baaca03db99d00808acfec43a44e81ecbf7f/docs/docs/assets/svg/docker.svg">&emsp13;Docker

Pull the latest Docker image from the Docker Hub repository.
To run `readmeai` in a containerized environment, pull latest Docker image from Docker Hub:

```sh
❯ docker pull zeroxeli/readme-ai:latest
Expand Down Expand Up @@ -406,7 +426,8 @@ Or, use `poetry` to build the project:
</details><br>

> [!IMPORTANT]
> To use the **Anthropic** and **Google Gemini** clients, additional dependencies are required. See the following installation commands:
> To use the **Anthropic** and **Google Gemini** clients, extra dependencies are required. Install the package with the following extras:
>
> - **Anthropic:**
> ```sh
> ❯ pip install "readmeai[anthropic]"
Expand All @@ -415,6 +436,11 @@ Or, use `poetry` to build the project:
> ```sh
> ❯ pip install "readmeai[google-generativeai]"
> ```
>
> - **Install Multiple Clients:**
> ```sh
> ❯ pip install "readmeai[anthropic,google-generativeai]"
> ```
## 🤖 Running the CLI
Expand Down Expand Up @@ -644,7 +670,7 @@ Run the following command to view all available options:

## 🎨 Examples

View example README files generated by readme-ai across various tech stacks:
View example README files generated by readme-ai across various Tech Stacks:

| Technology | Example Output | Repository | Description |
|------------|---------------|------------|-------------|
Expand Down Expand Up @@ -711,11 +737,30 @@ README-AI is released under the terms of the [MIT License][license].
<!-- Documentation -->
[mkdocs]: https://eli64s.github.io/readme-ai "Official Documentation"
<!-- Package managemers/container runtimes -->
[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"
<!-- Git hosting services -->
[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"
<!-- LLM API developer docs -->
[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"
<!-- GitHub Links -->
[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"
<!-- Example READMEs -->
[default]: https://github.com/eli64s/readme-ai/blob/main/examples/readme-ai.md "readme-python.md"
Expand Down
24 changes: 21 additions & 3 deletions docs/docs/assets/svg/readme-ai-logo-gradient.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 99c4907

Please sign in to comment.