From f2a72d9d7b0fc32db6be3a403bb1c6a5513aa35e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lucas=20Tost=C3=A9e?= Date: Tue, 30 Jul 2019 20:14:12 +0200 Subject: [PATCH] Update name --- .github/CONTRIBUTING.md | 2 +- README.md | 22 +++++++++++----------- lib/cli.js | 2 +- lib/template/default.md | 2 +- package.json | 4 ++-- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ae763cf..f80cdb4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,5 +1,5 @@ # Contributing -we are happy that you want to contribute to this project, first of all we know it is a bit painful but please it is important to read the [code of conduct file](https://github.com/luctst/getreadme/blob/master/.github/CODE_OF_CONDUCT.md). +we are happy that you want to contribute to this project, first of all we know it is a bit painful but please it is important to read the [code of conduct file](https://github.com/luctst/get-good-readme/blob/master/.github/CODE_OF_CONDUCT.md). ## How to contribute ? It is possible to contribute in many ways, either you want to solve a problem or you have an idea and you'll like to add it in the project. diff --git a/README.md b/README.md index 46867d0..9c53df9 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -# 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 `npm@5.2.0` 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. @@ -19,16 +19,16 @@ By typing this command you ask your OS system to install a package in global mod > **Note** - `npm@5.2.0` 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) diff --git a/lib/cli.js b/lib/cli.js index e4bc2e0..00db6f0 100644 --- a/lib/cli.js +++ b/lib/cli.js @@ -4,7 +4,7 @@ const figlet = require("figlet"); const fs = require("fs"); console.log( - figlet.textSync("getreadme", { + figlet.textSync("get-good-readme", { horizontalLayout: "full" }) ); diff --git a/lib/template/default.md b/lib/template/default.md index 43d5dc8..4574cca 100644 --- a/lib/template/default.md +++ b/lib/template/default.md @@ -25,4 +25,4 @@ List of maintainers. ## License Enter what king of license you're using. -

File generated with getreadme module.

+

File generated with get-good-readme module.

diff --git a/package.json b/package.json index 8e810ba..464de9f 100644 --- a/package.json +++ b/package.json @@ -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 (https://www.lucas-tostee.com)", "license": "MIT",