Readma

Beautiful effortless README generator
📖 Explore the docs »

View Demo · Report Bug · Request Feature

Table of contents

1. 💡 About the project
2. ✨ Features
3. 🎉 Getting started
4. 📋 Installation
5. 🔧 Usage
6. 🚀 Roadmap
7. ⛑️ Support
8. 💻 Contributing
9. 📨 Contact
10. 👏 Acknowledgments
11. 📄 License

💡 About the project

Create README that rocks

Tip

You are inside the entry point of readma workspace, here is a list of available packages

Package	Description
@readma/core	Beautiful effortless README generator core package
@readma/cli	Beautiful effortless README generator cli package
@readma/pkg-json	Typed function to read package.json

✨ Features

• Workspace compatible
• Automatic shields
• Cross platform

🎉 Getting started

See screenshot

📋 Installation

deno install @readma/core

🔧 Usage

🚧 In construction, refer to the docs

🚀 Roadmap

• CLI with config file
• Workspace readme generated from known files like Cargo.toml/deno.json/pnpm-workspace.yml
• Github issue template links

See the open issues for a full list of proposed features (and known issues).

⛑️ Support

Software is still very early expect unexpected breaking changes

💻 Contributing

Any contributions you make are greatly appreciated.

Note

Check the code of conduct

📨 Contact

elcoosp - @elcoosp - elcoosp@gmail.com

Project Link: https://github.com/elcoosp/readma

👏 Acknowledgments

• Best Readme
• Badges 4 README

📄 License

^{Licensed under MIT license}