Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.32 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.32 KB
Raw

Simple Readme

Generate readme fastly and simply with Simple Readme


Simple Readme Gif

Features

  • Includes one template based on this article;
  • Support En and pt-BR languages;
  • Generates title and badges by reading the name of the project on the package.json or the root folder;
  • Generates a link to your Github profile;

Settings

You can add these settings in your settings.json

 "simple.readme.settings.github": "YOUR GITHUB USERNAME"

 "simple.readme.settings.name": "YOUR GITHUB NAME"

 "simple.readme.settings.lang": "THE TEMPLATE LANGUAGE" // Default en

  • simple.readme.settings.github: To add links for you Github profile and to get your repository badges;
  • simple.readme.settings.name: To put your name on the file end;
  • simple.readme.settings.lang: The template language;

Template

  • App gif/image;

  • Title;

  • Badges;

  • Status;

  • Menu content;

  • sections

    • About your project;
    • Features;
    • Technologies;
    • Requirements;
    • Starting;
    • License;

To see the markdown template, click here

To see how the resulting final looks like, click here;