Skip to content

Commit

Permalink
💬 Update project name
Browse files Browse the repository at this point in the history
  • Loading branch information
Franck committed Jun 8, 2019
1 parent 56d7e78 commit 2cad8e3
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 20 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
<h1 align="center">Welcome to readme-cli 👋</h1>
<h1 align="center">Welcome to readme-md-generator 👋</h1>
<p>
<img src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
<img src="https://badges.greenkeeper.io/kefranabg/readme-cli.svg" />
<a href="https://github.com/kefranabg/readme-cli#readme">
<a href="https://github.com/kefranabg/readme-md-generator#readme">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" />
</a>
<a href="https://github.com/kefranabg/readme-cli/graphs/commit-activity">
<a href="https://github.com/kefranabg/readme-md-generator/graphs/commit-activity">
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" target="_blank" />
</a>
<a href="https://github.com/kefranabg/readme-cli/blob/master/LICENSE">
<a href="https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" target="_blank" />
</a>
</p>
Expand All @@ -19,26 +18,26 @@
With npm :

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

With yarn :

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

## Usage

Just run the following command and answer questions :

```sh
readme-cli
readme-md-generator
```

## Contributing

Contributions, issues and feature requests are welcome. Feel free to check [issues page](https://github.com/kefranabg/readme-cli/issues) if you want to contribute.
Contributions, issues and feature requests are welcome. Feel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues) if you want to contribute.

## Author

Expand All @@ -55,8 +54,8 @@ Please ⭐️ this repository if you like it.

Copyright © 2019 [Franck Abgrall](https://github.com/kefranabg).

📜 This project is [MIT](https://github.com/kefranabg/readme-cli/blob/master/LICENSE) licensed.
📜 This project is [MIT](https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE) licensed.

---

_This README was generated with ❤️ by [readme-cli](https://github.com/kefranabg/readme-cli)_
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 7 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "readme-cli",
"name": "readme-md-generator",
"version": "1.0.0",
"description": "Generates beautiful README files from git config & package.json infos",
"main": "src/index.js",
Expand Down Expand Up @@ -27,19 +27,21 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/kefranabg/readme-cli.git"
"url": "git+https://github.com/kefranabg/readme-md-generator.git"
},
"keywords": [
"readme",
"md",
"cli",
"generator"
"generator",
"template"
],
"author": "Franck Abgrall",
"license": "MIT",
"bugs": {
"url": "https://github.com/kefranabg/readme-cli/issues"
"url": "https://github.com/kefranabg/readme-md-generator/issues"
},
"homepage": "https://github.com/kefranabg/readme-cli#readme",
"homepage": "https://github.com/kefranabg/readme-md-generator#readme",
"engines": {
"npm": ">=5.5.0",
"node": ">=9.3.0"
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ yargs
)
.help()
.epilog(
'for more information, find our manual at https://github.com/kefranabg/readme-cli'
'for more information, find our manual at https://github.com/kefranabg/readme-md-generator'
)
.parse()
2 changes: 1 addition & 1 deletion templates/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<% } -%>
<% if (isGithubRepos) { -%>
<a href="<%= repositoryUrl %>/graphs/commit-activity">
<img alt="Maintenance" src="https://img.shields.io/github/issues-closed/readme-cli/readme-cli.svg" target="_blank" />
<img alt="Maintenance" src="https://img.shields.io/github/issues-closed/readme-md-generator/readme-md-generator.svg" target="_blank" />
</a>
<% } -%>
<% if (licenseName && licenseUrl) { -%>
Expand Down
2 changes: 1 addition & 1 deletion templates/footer.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
_This README was generated with ❤️ by [readme-cli](https://github.com/kefranabg/readme-cli)_
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

0 comments on commit 2cad8e3

Please sign in to comment.