Skip to content

Commit

Permalink
Update docs to use npx
Browse files Browse the repository at this point in the history
  • Loading branch information
samit4me committed Jun 17, 2019
1 parent e87ed1a commit 4747ad5
Showing 1 changed file with 5 additions and 18 deletions.
23 changes: 5 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,32 +56,19 @@ Example of `package.json` with good meta data:
}
```

## 📦 Install

With npm:

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

With yarn:

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

## 🚀 Usage

Just run the following command at the root of your project and answer questions:

```sh
readme
npx readme-md-generator
```

### Available options
OR use default values for all questions (`-y, --yes`):

- `--version` Display `readme-md-generator` version number
- `-y, --yes` Use default values for all questions
```sh
npx readme-md-generator -y
```

## 🤝 Contributing

Expand Down

0 comments on commit 4747ad5

Please sign in to comment.