Gallery
Explore various README examples from different programming languages and technologies. Each example showcases a README file from a different repository and project type.
| Technology | Example Output | Repository | Description |
|---|---|---|---|
| Readme-ai | readme-ai.md | readme-ai | Readme-ai project |
| Apache Flink | readme-pyflink.md | pyflink-poc | Pyflink project |
| Streamlit | readme-streamlit.md | readme-ai-streamlit | Streamlit web app |
| Vercel & NPM | readme-vercel.md | github-readme-quotes | Vercel deployment |
| Go & Docker | readme-docker-go.md | docker-gs-ping | Dockerized Go app |
| FastAPI & Redis | readme-fastapi-redis.md | async-ml-inference | Async ML inference service |
| Java | readme-java.md | Minimal-Todo | Minimalist todo Java app |
| PostgreSQL & DuckDB | readme-postgres.md | Buenavista | Postgres proxy server |
| Kotlin | readme-kotlin.md | android-client | Android client app |
| Offline Mode | offline-mode.md | litellm | LLM API service |
Find additional README examples in the examples directory.
Share Your README¶
To improve readme-ai and grow the community, we'd love to see the READMEs you created. If you have a README file that you'd like to share, please share it with us here. Cheers!