brawl-stars-api - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

package.json

 {
   "name": "brawl-stars-api",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "An API Wrapper for Brawl Stars API",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

@@ -1,1 +0,39 @@
-# brawl-stars-api
+# brawl-stars-api
+
+An API Wrapper for [Brawl Stars API](https://developer.brawlstars.com)
+
+# Installation
+
+`npm install --save brawl-stars-api`
+
+# Initialization
+
+```js
+const brawlApi = require('brawl-stars-api');
+const client = new brawlApi({
+    token: 'Token'
+})
+```
+You can also use `BS_API_TOKEN` env variable for the token
+
+## How to get a token?
+
+You can get your token [here](https://developer.brawlstars.com)
+
+## Club Search By Tag
+
+```js
+client
+.clubByTag('#VQJPJY0L')
+.then(res => console.log(res))
+.catch(err => console.log(err));
+```
+
+## Player Search By Tag
+
+```js
+client
+.playerByTag('#VQJPJY0L')
+.then(res => console.log(res))
+.catch(err => console.log(err));
+```

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

Improved metrics

Total package byte prevSize

4221

increased by19.88%

Number of lines in readme file

39

increased by3800%

No dependency changes