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

Commit

Permalink
Cosmetic improvements to the npm page.
Browse files Browse the repository at this point in the history
  • Loading branch information
lourot committed May 29, 2018
1 parent c1e0e88 commit fba3d89
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 12 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![npm version](https://img.shields.io/npm/v/@ghuser/github-contribs.svg)](https://www.npmjs.com/package/@ghuser/github-contribs)

# github-contribs

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

## Installation

> In construction. Not available on npm yet. For now do
>
> ```bash
> $ git clone https://github.com/AurelienLourot/github-contribs.git
> $ cd github-contribs/
> $ yarn install
> $ ./cli.js AurelienLourot
> ```
```bash
$ sudo npm install -g @ghuser/github-contribs
```

## Contributing

To run your local changes:

```bash
$ sudo npm install -g @ghuser/github-contribs
$ yarn install
$ ./cli.js --help
```

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

Yes, it is since that interface isn't public. We're monitoring it and will react as fast as we can
when it breaks.

## Changelog

**0.0.2** (2018-05-29):
* Cosmetic improvements to the [npm page](https://www.npmjs.com/package/@ghuser/github-contribs).

**0.0.1** (2018-05-29):
* Initial version.
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
const durationMsToQueryADay = 3500;
let warning = `Be patient. The whole process might take up to ${moment.duration(numOfDaysToQuery * durationMsToQueryADay).humanize()}...`;
if (!since && !until) {
warning += ' Consider using `--since` and/or `--until`.';
warning += ' Consider using --since and/or --until';
}
ora(warning).warn();

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ghuser/github-contribs",
"version": "0.0.1",
"version": "0.0.2",
"description": "List all GitHub repos a user has contributed to since the beginning of time.",
"license": "Unlicense",
"repository": {
Expand Down

0 comments on commit fba3d89

Please sign in to comment.