readme ai
v0.1.6
Designed for simplicity, customization, and developer productivity.
Overview
Demo
Features
Getting Started
Configuration
Examples
Contributing
Important
Visit the Official Documentation for detailed guides and tutorials.
README-AI is a developer tool that automatically generates README markdown files using a robust repository processing engine and advanced language models. Simply provide a URL or path to your codebase, and a well-structured and detailed README will be generated.
Why README-AI?
This tool is designed to streamline the documentation process for developers, saving time and effort while ensuring high-quality README files. Key benefits include:
AI-Powered: Leverage language models for intelligent content generation.
Consistency: Ensure clean, standardized documentation across projects.
Customization: Tailor the output to fit your project's requirements.
Language Agnostic: Works with most programming languages/frameworks.
Save Time: Generate comprehensive READMEs in less than a minute.
Running from the command line:
Running directly in your browser:
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.
Offline Mode: Create boilerplate README files offline, without any external API calls.
Best Practices: Ensures clean, professional documentation, adhering to markdown best practices.
Let's take a look at some possible customizations created by readme-ai:
| Pip Recommended method for most users: ❯ pip install readmeai PipxUse pipx to use ❯ pipx install readmeai UvUse uv for the fastest way to install ❯ uv tool install readmeai DockerTo run ❯ docker pull zeroxeli/readme-ai:latest From sourceClick to expand instructions
Alternatively, the project can be setup using the bash script below: Bash
Or, use Poetry
Important To use the Anthropic and Google Gemini clients, extra dependencies are required. Install the package with the following extras:
? Running the CLI1. Set Up Environment Variables With OpenAI: ❯ export OPENAI_API_KEY=<your_api_key># Or for Windows users:❯ set OPENAI_API_KEY=<your_api_key> Additional Providers (Ollama, Anthropic, Google Gemini)OllamaRefer to the Ollama documentation for more information on setting up the Ollama API. Here is a basic example:
Anthropic
Google Gemini
2. Generate a README Run the following command, replacing the repository URL with your own: ❯ readmeai --repository https://github.com/eli64s/readme-ai --api openai Important By default, the Run with ❯ readmeai --api ollama --model llama3 --repository https://github.com/eli64s/readme-ai Run with ❯ readmeai --api anthropic -m claude-3-5-sonnet-20240620 -r https://github.com/eli64s/readme-ai Run with ❯ readmeai --api gemini -m gemini-1.5-flash -r https://github.com/eli64s/readme-ai Use a readmeai --repository /path/to/your/project Add more customization options: ❯ readmeai --repository https://github.com/eli64s/readme-ai --output readmeai.md --api openai --model gpt-4 --badge-color A931EC --badge-style flat-square --header-style compact --toc-style fold --temperature 0.9 --tree-depth 2 --image LLM --emojis DockerRun the Docker container with the OpenAI client: ❯ docker run -it --rm -e OPENAI_API_KEY=$OPENAI_API_KEY -v "$(pwd)":/app zeroxeli/readme-ai:latest --repository https://github.com/eli64s/readme-ai --api openai From sourceClick to expand instructionsBashIf you installed the project from source with the bash script, run the following command:
Poetry
StreamlitTry readme-ai directly in your browser, no installation required. See the readme-ai-streamlit repository for more details. TestingThe pytest and nox frameworks are used for development and testing. Install the dependencies using Poetry: ❯ poetry install --with dev,test Run the unit test suite using Pytest: ❯ make test Run the test suite against Python 3.9, 3.10, 3.11, and 3.12 using Nox: ❯ make test-nox Tip Nox is an automation tool that automates testing in multiple Python environments. It is used to ensure compatibility across different Python versions. ConfigurationCustomize your README generation using these CLI options:
Run the following command to view all available options: ❯ readmeai --help Visit the Official Documentation for more detailed information on configuration options, examples, and best practices. ExamplesView example README files generated by readme-ai across various Tech Stacks:
Find additional README examples in the examples directory. Roadmap
ContributingContributions are welcome! Please read the Contributing Guide to get started.
Acknowledgments
LicenseCopyright © 2023 readme-ai. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
