Skip to content

Commit

Permalink
✨ Improve README content
Browse files Browse the repository at this point in the history
  • Loading branch information
Franck committed Jun 6, 2019
1 parent 0b4fe40 commit 5c4c2e8
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 14 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,44 @@

> Generates beautiful README files
## πŸ‘€ Author
## Install

**Franck Abgrall**
With npm :

```sh
npm i -g readme-cli
```

With yarn :

```sh
yarn global add readme-cli
```

## Usage

Just run the following command and answer questions :

```sh
readme-cli
```

## Author

πŸ‘€ **Franck Abgrall**

- Twitter πŸ‘‰[@FranckAbgrall](https://twitter.com/FranckAbgrall)
- Github πŸ‘‰[@kefranabg](https://github.com/kefranabg)

## πŸ™ Show your support
## Show your support

Please ⭐️ this repository if you like it.

## πŸ“œ License
## License

Copyright Β© 2019 [Franck Abgrall](https://github.com/kefranabg).
This project is under [license](https://github.com/kefranabg/readme-cli/blob/master/LICENSE).

πŸ“œ This project is under [license](https://github.com/kefranabg/readme-cli/blob/master/LICENSE).

---

Expand Down
18 changes: 9 additions & 9 deletions templates/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,28 @@
> <%= projectDescription %>
<% } -%>
## πŸ“¦ Install
## Install

```sh
npm i
```

## πŸš€ Usage
## Usage

```sh
npm run start
```

## βœ… Run tests
## Run tests

```sh
npm run test
```
<% if (authorName || authorTwitterUsername || authorGithubUsername) { -%>

## πŸ‘€ Author
## Author
<% if (authorName) { %>
**<%= authorName %>**
πŸ‘€ **<%= authorName %>**
<% } %>
<% if (authorTwitterUsername) { -%>
* Twitter πŸ‘‰[@<%= authorTwitterUsername %>](https://twitter.com/<%= authorTwitterUsername %>)
Expand All @@ -35,17 +35,17 @@ npm run test
<% } -%>
<% } -%>

## πŸ™ Show your support
## Show your support

Please ⭐️ this repository if you like it.
<% if (licenseUrl) { -%>

## πŸ“œ License
## License

<% if (authorName && authorGithubUsername) { -%>
Copyright Β© <%= currentYear %> [<%= authorName %>](https://github.com/<%= authorGithubUsername %>).
<% } -%>
This project is under [license](<%= licenseUrl %>).
<% } %>
πŸ“œ This project is under [license](<%= licenseUrl %>).
<% } -%>

***
Expand Down

0 comments on commit 5c4c2e8

Please sign in to comment.