Skip to main content

Introduction

Let's discover Readma in less than 5 minutes.

Getting Started​

Configuration​

Create a readma.config.ts file at the root of your project workspace.

Export default a config object following this type

readma.config.ts
// @ts-ignore
import { type types, utils } from '@readma/core'
const name = 'readma'
const author = 'elcoosp'
const urls = {
  doc: `https://${name}.vercel.app/`,
}
const config: types.ReadmeTemplateArgs = {
  language: 'ts',
  title: 'Readma',
  author,
  githubUsername: author,
  repoName: name,
  xHandle: author,
  domain: 'gmail',
  email: author,
  urls,
  repobeats: '1b12e7ffd13fd2d15772a30e8b0a995976150797',
  images: { screenshot: 'images/screenshot.gif', logo: 'images/logo.png' },
  sections: {
    features: `
- Workspace compatible
- Automatic shields
- Cross platform`,
    projectDescription: 'Beautiful effortless README generator',
    about: 'Create README that rocks',
    installation: utils.md.code(`deno install @${name}/core`),
    acknowledgments: `
- [Best Readme](https://github.com/othneildrew/Best-README-Template)
- [Badges 4 README](https://github.com/alexandresanlim/Badges4-README.md-Profile)`,
    gettingStarted: 'See screenshot',
    usage: `🚧 In construction, refer to the [docs](${urls.doc})`,
    roadmap: `
- [x] CLI with config file
- [x] Workspace readme generated from known files like \`Cargo.toml\`/\`deno.json\`/\`pnpm-workspace.yml\`
- [x] Github issue template links`,
    '⛑️ Support':
      'Software is still **very early** expect **unexpected breaking changes**',
  },
  template: {
    bugReport: 'bug-report.yml',
    featRequest: 'feature-request.yml',
  },
  backToTop: false,
}  as const
export default config

What you'll need​

  • Deno version 2 or above
  • Node (used to read the configuration file)

Run @readma/cli​

Generate readme(s) of your project workspace​

Generate a readme per project workspace member and/or a main one by running the following command

danger

Will overwrite README.md files, be sure to commit those before

deno run -A jsr:@readma/cli gen