generated from luctst/luctst-cli
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
16 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,34 @@ | ||
# getreadme | ||
[![Build Status](https://travis-ci.com/luctst/getreadme.svg?branch=master)](https://travis-ci.com/luctst/getreadme) | ||
[![Dependencies](https://img.shields.io/david/luctst/getreadme.svg?style=popout-square)](https://david-dm.org/luctst/getreadme) | ||
# get-good-readme | ||
[![Build Status](https://travis-ci.com/luctst/get-readme.svg?branch=master)](https://travis-ci.com/luctst/get-readme) | ||
[![Dependencies](https://img.shields.io/david/luctst/get-good-readme.svg?style=popout-square)](https://david-dm.org/luctst/get-good-readme) | ||
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) | ||
[![Twitter](https://img.shields.io/twitter/follow/luctstt.svg?label=Follow&style=social)](https://twitter.com/luctstt) | ||
|
||
*Quickly generate readable and well documented README file. Because documenting is a complicated task getreadme is a tiny CLI module which allows you to choose between diferents README templates for you to keep a coherence between your different projects.* | ||
*Quickly generate readable and well documented README file. Because documenting is a complicated task get-good-readme is a tiny CLI module which allows you to choose between diferents README templates for you to keep a coherence between your different projects.* | ||
|
||
## Install | ||
> **Note** - If you had `[email protected]` or more you can skip this section. | ||
You can install getreadme by entering this command | ||
You can install get-good-readme by entering this command | ||
``` | ||
npm install -g getreadme | ||
npm install -g get-good-readme | ||
``` | ||
|
||
By typing this command you ask your OS system to install a package in global mode on your computer some errors may happen due to some permissions, feel free to check how to allow the global installation of a nodejs package according to your OS system. | ||
|
||
> **Note** - `[email protected]` introduce a new way to handle packages which allows you to use packages without the need to install it globally, if you don't have this version it's recommended to install it by running `npm install -g npm@latest` | ||
## Usage | ||
getreadme is really simple to use: | ||
get-good-readme is really simple to use: | ||
|
||
1. Create a new folder. | ||
2. Open your terminal and go inside the new folder. | ||
3. If you had npx: | ||
* if you had npx run `npx getreadme` and follow the instructions. | ||
* if you had npx run `npx get-good-readme` and follow the instructions. | ||
4. If you don't have npx: | ||
* Check the install section to install the package globally. | ||
* Then execute the tasks number 1 and 2. | ||
* Run `getreadme` in your terminal. | ||
* Run `get-good-readme` in your terminal. | ||
|
||
## Features | ||
* Fast. | ||
|
@@ -40,7 +40,7 @@ getreadme is really simple to use: | |
* More templates. | ||
|
||
## Contributing | ||
Is is really important to read the [CONTRIBUTING](https://github.com/luctst/getreadme/blob/master/.github/CONTRIBUTING.md) file if you wish to contribute to this project. | ||
Is is really important to read the [CONTRIBUTING](https://github.com/luctst/get-good-readme/blob/master/.github/CONTRIBUTING.md) file if you wish to contribute to this project. | ||
|
||
## License | ||
MIT [LucTst](https://github.com/luctst/getreadme/blob/master/.github/LICENSE) | ||
MIT [LucTst](https://github.com/luctst/get-good-readme/blob/master/.github/LICENSE) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"name": "getreadme", | ||
"name": "get-good-readme", | ||
"version": "1.0.0", | ||
"description": "CLI tool to generate an esthetic README file ππ", | ||
"main": "lib/cli.js", | ||
|
@@ -37,7 +37,7 @@ | |
"templates", | ||
"cli-template", | ||
"templates", | ||
"getreadme" | ||
"get-good-readme" | ||
], | ||
"author": "LucTst <[email protected]> (https://www.lucas-tostee.com)", | ||
"license": "MIT", | ||
|