SanjaySunil / readme-components

Generate a neat and informative README using customizable components.

readme-components

Generate a neat and informative README using customizable components

Report Bug · Request Feature

What's readme-components?

readme-components is a lightweight, easy-to-use tool for generating beautiful, concise and informative README's within seconds. The tool allows you to create templates which can be reused across many projects and makes README writing 100x easier and hassle-free. It requires little knowledge to use and you can get started right away with the following steps.

Install

$ npm install readme-components

Usage

readme-components

import README from "readme-components";

let template = new README();

template.use_component("./templates/header.md", {
  name: "My AMAZING README!",
  description: "Customizable and reusable!",
});

template.use_component("./templates/license.md", {
  author: "John Doe",
  email: "[e-mail]",
  license: "MIT",
});

template.make_readme();

Markdown components

readme-components has some premade components that can be used in your own READMEs.

Simply use .use_premade(template) in order to make use of them!

Example

import README from "readme-components";

template = new README();

template.use_premade("header", {
  name: "my-awesome-readme",
  description: "made using a premade header!"
});

template.make_readme();

Making your own components

Making components is just the same as normal markdown. However, anything that needs to be replaced during build needs to be wrapped round with curly brackets and an identifer.

template.md

## My {descriptive_word} component

Such a descriptive word.

make_template.js

import README from "readme-components";

template = new README();

template.use_component("./template.md", {
  descriptive_word: "incomprehensible",
});

template.make_readme();

License

Copyright © 2022 Sanjay Sunil ([e-mail])

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