Skip to content

Commit 58a96e6

Browse files
committed
📝 doc: update readme
1 parent 0c1f577 commit 58a96e6

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
[![GitHub forks](https://img.shields.io/github/forks/DeeshanSharma/eslintrc-generator?logo=github&style=for-the-badge)](https://github.com/DeeshanSharma/eslintrc-generator/network)
2727
[![GitHub stars](https://img.shields.io/github/stars/DeeshanSharma/eslintrc-generator?logo=github&style=for-the-badge)](https://github.com/DeeshanSharma/eslintrc-generator/stargazers)
2828
[![GitHub pull requests](https://img.shields.io/github/issues-pr/DeeshanSharma/eslintrc-generator?logo=github&style=for-the-badge)](https://github.com/DeeshanSharma/eslintrc-generator/pulls)
29-
[![GitHub License](https://img.shields.io/github/license/deeshansharma/eslintrc-generator?color=sucess&logo=gnu%20privacy%20guard&logoColor=white&style=for-the-badge)](https://github.com/DeeshanSharma/eslintrc-generator/blob/main/LICENSE)
29+
[![GitHub License](https://img.shields.io/github/license/DeeshanSharma/eslintrc-generator?color=sucess&logo=gnu%20privacy%20guard&logoColor=white&style=for-the-badge)](https://github.com/DeeshanSharma/eslintrc-generator/blob/main/LICENSE)
3030

3131
</div>
3232

@@ -41,7 +41,7 @@
4141

4242
<hr />
4343

44-
<p align="center">Eslintrc-Generator is a simple but a time saving command line tool which will help you setup your eslint, project and code formatter with all the configuration you want. You just have to answer some really simple questions and this tool will do all the heavy lifting for you creating the file according to config and installing all the required packages</p>
44+
<p align="center">Eslintrc-Generator is a simple but time-saving command-line tool that will help you setup your eslint, project, and code formatter with all the configuration you want. You just have to answer some really simple questions and this tool will do all the heavy lifting for you creating the file according to config and installing all the packages</p>
4545

4646
## 💡 Features
4747

@@ -52,9 +52,9 @@
5252
- Prettier
5353
- React
5454
1. Ask questions and creates config based on your choice
55-
1. You have complete control on the configuration
55+
1. You have complete control over the configuration
5656
1. Checks for package.json file and `npm init -y` if not found
57-
1. Installs all required packages as dev dependency according to config
57+
1. Installs all required packages as dev dependency as per the config
5858
1. Uses your preferred package manager
5959

6060
## ⛏️ Built with
@@ -69,6 +69,7 @@ Follow all these instructions and learn the best way to take benefits from this
6969

7070
### 📚 Prerequisite
7171

72+
- Node
7273
- npm/yarn
7374

7475
### 🧰 Installation
@@ -79,6 +80,8 @@ Follow all these instructions and learn the best way to take benefits from this
7980
npm i eslintrc-generator -g
8081
```
8182

83+
> _**Note:** Global installation is not possible with yarn v2 as far as I know, (please guide me if I am wrong). If you are using yarn v1 then use `yarn global add eslintrc-generator`. But I recommend using the global method_
84+
8285
1. Per project installation
8386

8487
```bash
@@ -89,9 +92,7 @@ Follow all these instructions and learn the best way to take benefits from this
8992
yarn add eslintrc-generator
9093
```
9194

92-
> _**Note:** Global installation is not possible with yarn v2 as far as I know, (please guide me if I am wrong). If you are using yarn v1 then use `yarn global add eslintrc-generator`. But I recommend using the global method_
93-
94-
1. Command to generate rc file
95+
1. Command to generate RC file
9596

9697
```bash
9798
npx generate-eslintrc
@@ -103,7 +104,7 @@ Follow all these instructions and learn the best way to take benefits from this
103104

104105
## 🎈 Usage
105106

106-
The package is made to save time in configuring **Eslint** with your project and also with **Prettier**, _(if you have done this before you already know the pain)_. The tool will ask you certain questions, prepare a config and required packages list, install all the packages and create the RC file perfectly compatible with your project as well as Prettier for you as per the config. You just need to focus on your awesome project.
107+
The package is made to save time configuring **Eslint** and **Prettier**, with your project _(if you have done this before you already know the pain)_. The tool will ask you certain questions, prepare a config and required packages list based on your answers, install all the packages and create the RC file perfectly compatible with your project as well as Prettier. You just need to focus on your awesome project.
107108

108109
## ✍️ Authors
109110

@@ -113,7 +114,7 @@ The package is made to save time in configuring **Eslint** with your project and
113114

114115
**_"In real open source, you have the right to control your own destiny."_** _- Linus Torvalds_
115116

116-
Contributions are what make the open source community an amazing place. Any contributions you make are **greatly appreciated**.
117+
Contributions are what makes the open-source community an amazing place. Any contributions you make are **greatly appreciated**.
117118

118119
## 💳 License
119120

@@ -136,6 +137,6 @@ Distributed under the MIT License. See [`LICENSE`](LICENCE) for more information
136137
- [Figlet.js](https://github.com/patorjk/figlet.js)
137138
- [Clear](https://github.com/bahamas10/node-clear)
138139

139-
## 👋 End Note
140+
## 👋 EndNote
140141

141-
Star this project so that you don't miss it when you need it and avoid wasting time in Googling the stuff and just focus on the build.
142+
Star this project so you don't miss it when you need it and avoid wasting time Googling the stuff and just focus on the build.

0 commit comments

Comments
 (0)