create-rdme
Version:
create-rdme CLI
104 lines (67 loc) ⢠2.42 kB
Markdown
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/nihaladoni/create-rdme">

</a>
<h2 align="center">Readme CLI</h2>
<p align="center">
A CLI tool to generate Readme, Contributing and License files for the github projects.
</p>
<!-- Shields -->
<div align="center">
<a href="https://standardjs.com">
<img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat"
alt="Standard" />
</a>
.
<img src="https://img.shields.io/github/languages/code-size/nihaladoni/create-rdme?style=flat-square" alt="Code size" />
.
<img src="https://img.shields.io/github/license/nihaladoni/create-rdme?style=flat-square" alt="License" />
.
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/nihaladoni/create-rdme?style=flat-square">
.
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/nihaladoni/create-rdme?style=social">
</div>
<br />
<br />
</div>

[View Generated Readme](GenReadme.md)
<!-- GETTING STARTED -->
## ā” Installation and usage
Use npx to generate the files in the project directory
```sh
npx create-rdme
```
<h5>or</h5>
Install the package globally ( enables autocomplete on second run for static values )
```sh
npm install -g create-rdme
```
š linux and mac users, add sudo before npm
Run the package using the command
```sh
create-rdme
```
<!-- ABOUT THE PROJECT -->
### š» Built with
<ul>
<li>Nodejs</li>
<li>NPM</li>
<li>gluegun</li>
<li>prompts</li>
<li>data-store</li>
</ul>
<!-- CONTRIBUTING -->
## š Contributing
Contributions are always welcome! . Please read the [contribution guidelines](CONTRIBUTING.md) first.
<!-- CONTACT -->
## š“ļø Contact
- Email : [nihaladoni@gmail.com](mailto:nihaladoni@gmail.com)
- Linkedin : [@nehaladoni](https://linkedin.com/in/nehaladoni)
- Twitter : [@nihaladni05](https://twitter.com/nihaladni05)
- Website : [nihaladoni.ml](https://nihaladoni.ml)
<!-- LICENSE -->
## š License
Distributed under the [MIT](LICENSE) License.