fortnite - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -1,5 +0,1 @@
-class Fortnite {
-  constructor() {
-
-  }
-}
+module.exports = require('./src/Client');

package.json

 {
   "name": "fortnite",
-  "version": "1.0.0",
-  "description": "Fortnite leaderboards.",
+  "version": "1.0.1",
+  "description": "An easy to use module for interacting with the Fortnite API.",
   "main": "index.js",
@@ -13,5 +13,2 @@ "scripts": {
   },
-  "keywords": [
-    "fortnite"
-  ],
   "author": "Jake Ruston <[e-mail]>",
@@ -23,5 +20,6 @@ "license": "MIT",
   "homepage": "https://github.com/Jake-Ruston/fortnite#readme",
-  "devDependencies": {
-    "eslint": "^4.9.0"
+  "dependencies": {
+    "cheerio": "^1.0.0-rc.2",
+    "snekfetch": "^3.5.2"
   }
 }

README.md

@@ -1,1 +0,21 @@
-# Fortnite 
+# Fortnite
+A simple to use module for interacting with the Fortnite API.
+
+## Install
+```
+$ npm install fortnite
+```
+## How to
+```js
+// require the package
+const Fortnite = require('fortnite');
+// instantiate the client
+const client = new Fortnite.Client();
+```
+## Methods
+```js
+client.info('mrappi', 'pc').then(data => data);
+client.stats('mrappi', 'pc').then(data => data);
+```
+- `username` is required and must be a string.
+- `platform` is `pc` by default and currently only supports PC.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3415

increased by425.38%

Dev dependency count

0

decreased by-100%

Number of package files

7

increased by133.33%

Lines of code

63

increased by1475%

Number of lines in readme file

22

increased by1000%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

2

increased byInfinity%

Dependency changes

• + Addedcheerio@^1.0.0-rc.2

• + Addedsnekfetch@^3.5.2

• + Addedboolbase@1.0.0(transitive)

• + Addedcheerio@1.0.0(transitive)

• + Addedcheerio-select@2.1.0(transitive)

• + Addedcss-select@5.1.0(transitive)

• + Addedcss-what@6.1.0(transitive)

• + Addeddom-serializer@2.0.0(transitive)

• + Addeddomelementtype@2.3.0(transitive)

• + Addeddomhandler@5.0.3(transitive)

• + Addeddomutils@3.1.0(transitive)

• + Addedencoding-sniffer@0.2.0(transitive)

• + Addedentities@4.5.0(transitive)

• + Addedhtmlparser2@9.1.0(transitive)

• + Addediconv-lite@0.6.3(transitive)

• + Addednth-check@2.1.1(transitive)

• + Addedparse5@7.2.1(transitive)

• + Addedparse5-htmlparser2-tree-adapter@7.1.0(transitive)

• + Addedparse5-parser-stream@7.1.2(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsnekfetch@3.6.4(transitive)

• + Addedundici@6.21.0(transitive)

• + Addedwhatwg-encoding@3.1.1(transitive)

• + Addedwhatwg-mimetype@4.0.0(transitive)