Skip to main content
Home
Browse packagesDocsSign in

@readma/cli@0.6.10
Built and signed on GitHub Actions

latest
elcoosp/readma

Beautiful effortless README generator cli package

This package works with DenoIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
JSR Score
100%
Published
11 hours ago (0.6.10)

JSR version Codecov Contributors Forks Stargazers Commit activity Branch action runs License


Logo

Readma

@readma/cli

Beautiful effortless README generator
📖 Explore the docs »

View Demo · Report Bug · Request Feature

Note

You are inside the @readma/cli workspace member package, not the repository entry point

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

💡 About the project

Create README that rocks

Product screenshot

✨ Features

  • Workspace compatible
  • Automatic shields
  • Cross platform

🎉 Getting started

See screenshot

📋 Installation

deno install @readma/cli

🔧 Usage

import { readme } from "@readma/core"
import config from "./readma.config.ts"
// Generate a single readme file
await readme(config, { folderPath: "./" })

🚀 Roadmap

  • CLI with config file
  • Auto defaults from known files like Cargo.toml/{deno,package}.json

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

💻 Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout-b feat/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feat/AmazingFeature)
  5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE.txt for more information.

📨 Contact

elcoosp - @elcoosp - [email protected]

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

👏 Acknowledgments

Alt

Built and signed on
GitHub Actions
View transparency log

Add Package

deno add jsr:@readma/cli

Import symbol

import * as cli from "@readma/cli";

---- OR ----

Import directly with a jsr specifier

import * as cli from "jsr:@readma/cli";

Add Package

npx jsr add @readma/cli

Import symbol

import * as cli from "@readma/cli";

Add Package

yarn dlx jsr add @readma/cli

Import symbol

import * as cli from "@readma/cli";

Add Package

pnpm dlx 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";