Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
Beautiful effortless README generator cli package
Readma
@readma/cli
Beautiful effortless README generator
📖 Explore the docs »
View Demo
·
Report Bug
·
Request Feature
You are inside the @readma/cli workspace member package, not the repository entry point
Table of contents
💡 About the project
Create README that rocks
✨ Features
- Workspace compatible
- Automatic shields
- Cross platform
🎉 Getting started
See screenshot
📋 Installation
deno add @readma/cli
🔧 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.
Check the code of conduct
📄 License
Distributed under the MIT License. See LICENSE.txt for more information.
📨 Contact
elcoosp - @elcoosp - elcoosp@gmail.com
Project Link: https://github.com/elcoosp/readma
👏 Acknowledgments
Add Package
deno add jsr:@readma/cli
Import symbol
import * as cli from "@readma/cli";
Import directly with a jsr specifier
import * as cli from "jsr:@readma/cli";
Add Package
pnpm i jsr:@readma/cli
pnpm dlx jsr add @readma/cli
Import symbol
import * as cli from "@readma/cli";
Add Package
yarn add jsr:@readma/cli
yarn dlx jsr add @readma/cli
Import symbol
import * as cli from "@readma/cli";
Add Package
vlt install jsr:@readma/cli
Import symbol
import * as cli from "@readma/cli";
Add Package
npx jsr add @readma/cli
Import symbol
import * as cli from "@readma/cli";
Add Package
bunx jsr add @readma/cli
Import symbol
import * as cli from "@readma/cli";