Skip to content

Commit

Permalink
Fix README.md issues and update package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
b-cho committed Jan 23, 2021
1 parent 1e1b824 commit c9edf37
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ const totalMasteryPoints = (await galeforce.lol.mastery.summoner()

When initializing Galeforce, a config object (JSON) or a path to a YAML file must be passed to the `GaleforceModule()` constructor as an argument:
```javascript
const Galeforce = new GaleforceModule(/* config file path or object */);
const galeforce = new GaleforceModule(/* config file path or object */);
```
Such an object must have the following structure:

Expand Down
20 changes: 16 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,30 @@
{
"name": "galeforce",
"author": "Brandon Cho",
"description": "A customizable, promise-based, and command-oriented TypeScript library for the Riot Games API",
"repository": "https://github.com/bcho04/galeforce",
"author": {
"name": "Brandon Cho",
"email": "[email protected]",
"url": "https://github.com/bcho04"
},
"description": "A customizable, promise-based, and command-oriented TypeScript library for the Riot Games API.",
"keywords": ["galeforce", "api", "riot", "lol", "tft", "lor", "valorant", "league of legends", "teamfight tactics", "legends of runeterra", "riot games"],
"homepage": "https://github.com/bcho04/galeforce",
"repository": {
"type": "git",
"url": "https://github.com/bcho04/galeforce.git"
},
"bugs": "https://github.com/bcho04/galeforce/issues",
"version": "0.1.0",
"license": "Apache-2.0",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"engines": {
"node": ">=10.13.0"
},
"dependencies": {
"ajv": "^7.0.3",
"async": "^3.2.0",
"axios": "^0.21.1",
"bluebird": "^3.7.2",
"node": ">=10.13.0",
"redis": "^3.0.2",
"typescript-json-schema": "^0.47.0",
"yaml": "^1.10.0"
Expand Down

0 comments on commit c9edf37

Please sign in to comment.