From c9edf37b2155063c2f7d99cb77ebe7c7c920eddc Mon Sep 17 00:00:00 2001 From: bcho04 Date: Sat, 23 Jan 2021 15:26:49 -0800 Subject: [PATCH] Fix README.md issues and update package.json --- README.md | 2 +- package.json | 20 ++++++++++++++++---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ea3f278..e07b119 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/package.json b/package.json index d6b9ebb..2c80d30 100644 --- a/package.json +++ b/package.json @@ -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": "brandon.cho@gmail.com", + "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"