readmea

Scaffold aesthetic READMEs from the terminal.

┌─────────────────────────────────────────────────────────┐
│  $ readmea init --name magic-cli                        │
│  │                                                      │
│  │  # magic-cli                                         │
│  │  Do things. Fast.                                   │
│  │  [npm: 1.0.0]  [dl/mo ▓▓▓▓░░]  [MIT]  [★ 0]  [CI]  │
│  │                                                      │
│  │  ## Install                                          │
│  │  $ bun add magic-cli                                 │
│  └──────────────────────────────────────────────────────┘
└──────────────────────────────────────────────────────────┘

Zero weird dependencies. One command, a decent README, no typing pain.

| Jump | Description | | --- | --- | | install | get it | | quick start | first README in 10s | | options | every flag | | as a library | use the generator in code | | development | hack on it |

install

bun add -g readmea
npm install -g readmea

quick start

cd my-project

readmea init \
  --name my-project \
  --description "A shiny new tool" \
  --owner knownasrazi \
  --install "bun add my-project" \
  --feature "zero dependencies" \
  --feature "fully typed"

README.md appears. Done.

To preview first, print to the terminal instead:

readmea init --name my-project --stdout

options

| flag | what it does | | ---- | ------------ | | --name <n> | project name (defaults to the current folder) | | --description <d> | one-liner under the title | | --owner <o> | adds GitHub badges and repo URLs | | --npm <pkg> | npm package name for badges | | --install <cmd> | install command to render | | --usage <code> | any snippet placed under "Usage" | | --feature <f> | repeatable feature bullet | | --license <l> | license badge + footer (default MIT) | | --author <a> | footer credit | | --no-badges | skip the badge row entirely | | -o, --output <p> | write to a different path | | --stdout | print instead of writing | | --force | overwrite an existing file | | -h, --help | this help | | -v, --version | version number |

as a library

import { generateReadme } from "readmea";

const md = generateReadme({
  name: "my-lib",
  description: "A serious library.",
  owner: "knownasrazi",
  features: ["tree-shakeable", "tested"],
  usage: '```ts\nimport { run } from "my-lib"\n```',
});

console.log(md); // ready to write or pipe anywhere

API

| export | signature | | ------ | --------- | | generateReadme | (options: ReadmeaOptions) => string | | defaultInstall | (name: string) => string | | ReadmeaOptions | type of the options object |

development

git clone https://github.com/knownasrazi/readmea.git
cd readmea
bun install
bun test
bun run build
bun run lint

license

MIT - Razi - see LICENSE

This file was, of course, generated with readmea.