Skip to content
This repository was archived by the owner on Nov 8, 2020. It is now read-only.

Commit fba3d89

Browse files
committed
Cosmetic improvements to the npm page.
1 parent c1e0e88 commit fba3d89

File tree

3 files changed

+21
-12
lines changed

3 files changed

+21
-12
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![npm version](https://img.shields.io/npm/v/@ghuser/github-contribs.svg)](https://www.npmjs.com/package/@ghuser/github-contribs)
2+
13
# github-contribs
24

35
List **all** GitHub repos a user has contributed to **since the beginning of time**:
@@ -8,7 +10,7 @@ List **all** GitHub repos a user has contributed to **since the beginning of tim
810
```bash
911
$ github-contribs AurelienLourot
1012
✔ Fetched first day at GitHub: 2015-04-04.
11-
⚠ Be patient. The whole process might take up to an hour... Consider using `--since` and/or `--until`.
13+
⚠ Be patient. The whole process might take up to an hour... Consider using --since and/or --until
1214
✔ Fetched all commits and PRs.
1315
35 repo(s) found:
1416
AurelienLourot/lsankidb
@@ -19,18 +21,17 @@ dracula/gitk
1921

2022
## Installation
2123

22-
> In construction. Not available on npm yet. For now do
23-
>
24-
> ```bash
25-
> $ git clone https://github.com/AurelienLourot/github-contribs.git
26-
> $ cd github-contribs/
27-
> $ yarn install
28-
> $ ./cli.js AurelienLourot
29-
> ```
24+
```bash
25+
$ sudo npm install -g @ghuser/github-contribs
26+
```
27+
28+
## Contributing
3029

30+
To run your local changes:
3131

3232
```bash
33-
$ sudo npm install -g @ghuser/github-contribs
33+
$ yarn install
34+
$ ./cli.js --help
3435
```
3536

3637
## Team
@@ -69,3 +70,11 @@ API, we can't use a token to raise the limit.
6970

7071
Yes, it is since that interface isn't public. We're monitoring it and will react as fast as we can
7172
when it breaks.
73+
74+
## Changelog
75+
76+
**0.0.2** (2018-05-29):
77+
* Cosmetic improvements to the [npm page](https://www.npmjs.com/package/@ghuser/github-contribs).
78+
79+
**0.0.1** (2018-05-29):
80+
* Initial version.

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@
161161
const durationMsToQueryADay = 3500;
162162
let warning = `Be patient. The whole process might take up to ${moment.duration(numOfDaysToQuery * durationMsToQueryADay).humanize()}...`;
163163
if (!since && !until) {
164-
warning += ' Consider using `--since` and/or `--until`.';
164+
warning += ' Consider using --since and/or --until';
165165
}
166166
ora(warning).warn();
167167

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@ghuser/github-contribs",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"description": "List all GitHub repos a user has contributed to since the beginning of time.",
55
"license": "Unlicense",
66
"repository": {

0 commit comments

Comments
 (0)