Skip to content

Commit feede92

Browse files
committed
Update readme
1 parent 0530813 commit feede92

1 file changed

Lines changed: 79 additions & 48 deletions

File tree

README.md

Lines changed: 79 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
# luctst-cli
1+
<div align="center">
2+
<!-- <a href="#">
3+
<img src="https://media.giphy.com/media/JIX9t2j0ZTN9S/giphy-downsized.gif" alt="Logo project" height="160" />
4+
</a> -->
5+
<br>
6+
<br>
7+
<p>
8+
<b>luctst-cli</b>
9+
</p>
10+
<p>
11+
<i>A cli tool to generate node module project.</i>
12+
</p>
13+
<p>
214

315
[![Build Status](https://travis-ci.com/luctst/luctst-cli.svg?branch=master)](https://travis-ci.com/luctst/luctst-cli)
416
[![NPM version](https://img.shields.io/npm/v/luctst-cli?style=flat-square)](https://img.shields.io/npm/v/luctst-cli?style=flat-square)
@@ -8,70 +20,89 @@
820
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
921
[![Twitter](https://img.shields.io/twitter/follow/luctstt.svg?label=Follow&style=social)](https://twitter.com/luctstt)
1022

11-
*A cli tool to generate node module project.*
23+
</p>
24+
</div>
1225

13-
## Features
26+
---
27+
28+
**Content**
29+
30+
* [Features](##features)
31+
* [Install](##install)
32+
* [Usage](##usage)
33+
* [Exemples](##exemples)
34+
* [Documentation](##documentation)
35+
* [Contributing](##contributing)
36+
* [Maintainers](##maintainers)
37+
38+
## Features ✨
1439
* Eslint.
1540
* Prettier.
1641
* Ava.
42+
* Editor config.
1743
* Continue integration with TravisCi
1844

19-
## Usage
20-
To start using this package create a folder and run this command:
45+
## Install 🐙
2146
```
22-
npx luctst-cli start
47+
npm install luctst-cli
2348
```
24-
Follow the instructions :).
2549

26-
If you don't have npx try updating your nodejs version or run:
27-
```
28-
npm install luctst-cli -g
50+
## Usage 💡
51+
```sh
52+
npx luctst-cli [command] [options]
2953
```
3054

31-
Once your structure is created install all dependencies that you need and choose a script:
32-
```
33-
npm run test:watch
55+
## Exemples 🖍
56+
### Default path
57+
```sh
58+
npx luctst-cli start
3459
```
60+
Create structure at the root of your nodejs process.
3561

36-
Watch all files with `ava` in `test/` folder.
37-
```
38-
npm run lint:watch
62+
### Custom path
63+
```sh
64+
├── test
65+
66+
npx luctst-cli start --path=test/
3967
```
68+
Create project inside the `test` folder.
4069

41-
Watch all files with `estlint`, `prettier` in `lib` folder.
42-
> **Note** - Prettier can fix some errors automatically, run `npm run lint:fix`
70+
## Documentation 📄
71+
**Commands availables:**
72+
* `start`, start the process to create your project.
4373

44-
> **Note** - You must have node10.0.0
74+
**Flags:**
75+
* `--version -v`, show the package version.
76+
* `--help -h`, display all commands and flags availables.
77+
* `--path -p`, custom path where the project must be created
4578

46-
## Structure
47-
```
48-
├── .github
49-
│ ├── ISSUE_TEMPLATE
50-
│ │ ├── bug_report.md
51-
│ │ ├── feature_request.md
52-
│ ├── CODE_OF_CONDUCT.md
53-
│ ├── CONTRIBUTING.md
54-
│ ├── LICENSE
55-
│ ├── pull_request_template.md
56-
├── lib
57-
├── test
58-
│ ├── test.js
59-
│ ├── .editorconfig
60-
│ ├── .estlintrc.json
61-
│ ├── .gitattributes
62-
│ ├── .gitignore
63-
│ ├── .prettierignore
64-
│ ├── .prettierrc.json
65-
│ ├── .travis.yml
66-
│ ├── package-lock.json
67-
│ ├── package.json
68-
│ ├── README.md
69-
```
79+
**Scripts:**
80+
81+
Those scripts are runnables once the process is done:
82+
* `test`, Test all files in `test` folder with Ava.
83+
* `test:watch`, Watch and test all files in `test` folder with Ava.
84+
* `lint`, Lint all files with prettier and eslint in `lib` folder.
85+
* `lint:watch`, Watch and lint all files with prettier and eslint in `lib` folder.
86+
* `lint:fix`, Fix some errors and warnings automatically.
87+
88+
## Contributing 🍰
89+
Please make sure to read the [Contributing Guide](https://github.com/luctst/luctst-cli/blob/master/.github/CONTRIBUTING.md) before making a pull request.
90+
91+
Thank you to all the people who already contributed to this project!
7092

71-
## Contributing
72-
You've found an issue ? A new idea for the project and you want contribute ? It's nice, but before coding make sure you have read the [CONTRIBUTING.md](https://github.com/luctst/luctst-cli/blob/master/.github/CONTRIBUTING.md) file it is important.
93+
## Maintainers 👷
94+
<table>
95+
<tr>
96+
<td align="center"><a href="https://lucastostee.now.sh/"><img src="https://avatars3.githubusercontent.com/u/22588842?s=460&v=4" width="100px;" alt="Tostee Lucas"/><br /><sub><b>Tostee Lucas</b></sub></a><br /><a href="#" title="Code">💻</a></td>
97+
</tr>
98+
</table>
7399

74-
## Licence
75-
MIT [LICENSE](https://github.com/luctst/luctst-cli/blob/master/.github/LICENSE)
100+
## License ⚖️
101+
MIT
76102

77-
<p style="font-size:8px;text-align:center;margin-top:50px;">File generated with <a href="https://github.com/luctst/get-good-readme">get-good-readme</a> module.</p>
103+
---
104+
<div align="center">
105+
<b>
106+
<a href="https://www.npmjs.com/package/get-good-readme">File generated with get-good-readme module</a>
107+
</b>
108+
</div>

0 commit comments

Comments
 (0)