Skip to content

Commit

Permalink
Added basic linting
Browse files Browse the repository at this point in the history
  • Loading branch information
mrz1836 committed Dec 31, 2019
1 parent 19bbba4 commit 6aecdb9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This is a JavaScript library that has complete coverage for the [TonicPow API](h
Familiar with Go? Here's an [example in Go](https://github.com/tonicpow/go-tonicpow).

#### Prerequisites
- You have a [TonicPow `api_key`](https://docs.tonicpow.com)
- You have a [TonicPow _api_key_](https://docs.tonicpow.com)
- You have a back-end server (IE: [Node](https://nodejs.org/en/), [Go](https://golang.org/), [Firebase Functions](https://firebase.google.com/docs/functions))

## Install via npm (back-end)
Expand All @@ -36,9 +36,22 @@ And load the module in your project:
```javascript
let TonicPow = require('tonicpow-js');
await TonicPow.init('your-api-key', 'live')
```
```

View [examples](examples/examples.js) of using the package.


View [examples](examples/examples.js) of using the package.
#### Local Development
_(Optional)_ Run tests (requires `api_key` env var)
```bash
$ npm test
```

_(Optional)_ Lint & Build
```bash
$ npm run lint && npm run build
```


## Documentation
More overall API documentation can be found on [TonicPow Docs](https://docs.tonicpow.com)
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": "tonicpow-js",
"version": "0.1.12",
"version": "0.1.13",
"description": "TonicPow API Library in JS - https://docs.tonicpow.com",
"main": "lib/api.js",
"repository": {
Expand Down

0 comments on commit 6aecdb9

Please sign in to comment.