Skip to content

Commit 431f29e

Browse files
committed
Update readme
1 parent fd3b403 commit 431f29e

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,24 @@ Command line application allowing you to download all issues in the CSV format f
1111
- [Node.js](https://nodejs.org) (`v6.10.3 LTS`)
1212
- [Yarn](https://yarnpkg.com) (for development)
1313

14-
## Usage
15-
16-
### Install app globally
14+
## Installation
1715

1816
npm install -g git-issues-downloader
1917

20-
### Running the app
18+
## Ussage
2119

2220
git-issues-downloader <repository URL>
2321

22+
### Examples
23+
24+
Command prompt will ask for username and password credentials for GitHub
25+
26+
git-issues-downloader https://github.com/remoteorigin/git-issues-downloader
27+
28+
Example with username and password
29+
30+
git-issues-downloader -u <username> -p <username> https://github.com/remoteorigin/git-issues-downloader
31+
2432
## Development
2533

2634
### Project Setup
@@ -39,7 +47,7 @@ All tests are are written in [Mocha](https://mochajs.org/) and stored in the `te
3947

4048
yarn run test
4149

42-
### Lintining
50+
### Linting
4351

4452
Using [Standard](https://github.com/feross/standard) JavaScript linter & automatic code fixer.
4553

0 commit comments

Comments
 (0)