Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Oct 29, 2017
1 parent 433a5d6 commit 0906a23
Show file tree
Hide file tree
Showing 5 changed files with 655 additions and 8 deletions.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@
*.log
node_modules
*.env
.DS_Store
package-lock.json
3 changes: 2 additions & 1 deletion DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@

You can see below the API reference of this module.

### `GhPolyglot(input, token)`
### `GhPolyglot(input, token, host)`
Creates a new instance of `GhPolyglot`.

#### Params

- **String** `input`: The repository full name (e.g. `"IonicaBizau/gh-polyglot"`) or the username (e.g. `"IonicaBizau"`).
- **String** `token`: An optional GitHub token used for making authenticated requests.
- **String** `host`: An optional alternative Github FQDN (e.g. `"https://github.myenterprise.com/api/v3/"`)

#### Return
- **GhPolyglot** The `GhPolyglot` instance.
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


[![gh-polyglot](http://i.imgur.com/wQ2eGDb.png)](#)

# gh-polyglot

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/gh-polyglot.svg)](https://www.npmjs.com/package/gh-polyglot) [![Downloads](https://img.shields.io/npm/dt/gh-polyglot.svg)](https://www.npmjs.com/package/gh-polyglot)
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Version](https://img.shields.io/npm/v/gh-polyglot.svg)](https://www.npmjs.com/package/gh-polyglot) [![Downloads](https://img.shields.io/npm/dt/gh-polyglot.svg)](https://www.npmjs.com/package/gh-polyglot)

> Get language stats about GitHub users and repositories.
Expand All @@ -24,6 +23,7 @@ Using this library on the client side is possible as well, but it's dependent on
<script src="path/to/gh-polyglot.js"></script>
```


## :clipboard: Example


Expand Down Expand Up @@ -60,13 +60,14 @@ There are few ways to get help:
## :memo: Documentation


### `GhPolyglot(input, token)`
### `GhPolyglot(input, token, host)`
Creates a new instance of `GhPolyglot`.

#### Params

- **String** `input`: The repository full name (e.g. `"IonicaBizau/gh-polyglot"`) or the username (e.g. `"IonicaBizau"`).
- **String** `token`: An optional GitHub token used for making authenticated requests.
- **String** `host`: An optional alternative Github FQDN (e.g. `"https://github.myenterprise.com/api/v3/"`)

#### Return
- **GhPolyglot** The `GhPolyglot` instance.
Expand Down Expand Up @@ -125,7 +126,6 @@ this takes time. You can integrate and use these projects in your applications *
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Expand Down
Loading

0 comments on commit 0906a23

Please sign in to comment.