Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Dec 24, 2017
1 parent 982fa03 commit e8bd723
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ You can install the package globally and use it as command line tool:


```sh
$ npm i -g ghcal
# Using npm
npm install --global ghcal

# Using yarn
yarn global add ghcal
```


Expand Down Expand Up @@ -54,45 +58,58 @@ Documentation can be found at https://github.com/IonicaBizau/ghcal
```

## Usage

### Default behavior


If you are already using [`cli-github`](https://github.com/IonicaBizau/cli-github), then your GitHub username is kept into `~/.github-config.json` and `ghcal` will use it if you don't pass another username: `ghcal` will be the same with `ghcal -u <your-username>`.

```sh
ghcal
```

### Passing the username


Using the `-u` (or `--username`) option, you can specify the GitHub username:

```sh
# Fetches the izuzak's contributions
$ ghcal -u izuzak
```

### Themes


If you pass the `--light` option, then the light theme will be activated (the default theme is dark).

```sh
# jlord's contributions, light theme
$ ghcal jlord --light
```

### No ANSI styles


The `--no-ansi` option disables any colors in the output. Unicode characters, without colors will be used.

```sh
# @pengywynn's contributions, but without ANSI styles
$ ghcal pengwynn --no-ansi
```


## :clipboard: Example


Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm`:
Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm` (or `yarn`):

```sh
$ npm i --save ghcal
# Using npm
npm install --save ghcal

# Using yarn
yarn add ghcal
```


Expand All @@ -113,9 +130,11 @@ There are few ways to get help:

1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:



## :memo: Documentation

For full API reference, see the [DOCUMENTATION.md][docs] file.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@
"bloggify.json",
"bloggify/"
]
}
}

0 comments on commit e8bd723

Please sign in to comment.