bb-api-platforma 0.1.168

package/README.md

@@ -0,0 +1,44 @@
+# BetBooster API Platform
+
+Module package for working with API of BetBooster platform.
+
+## Installation
+
+To install the "bb-api-platforma" package, run the following command:
+
+```bash
+npm install gitlab:betseller/bb-api-platforma
+                
+```
+
+It is possible to use the command to update the package:
+
+```bash
+npm install bb-api-platforma
+```
+
+## Usage
+
+```javascript
+
+import axios from 'axios'
+import { BetBoosterApi } from 'bb-api-platforma';
+
+const axiosInstance = axios.create();
+const apiRootUrl = 'https://api.example.com';
+const defaultLanguage  = 'en';
+const maxTimeout = 15000;
+const isDevelopmentMode = !!process.env.DEV;
+const api = new BetBoosterApi(axiosInstance, apiRootUrl, defaultLanguage, maxTimeout, isDevelopmentMode);
+
+const res = await api2.login({ login: 'login', password: 'password' });
+
+console.log(res);
+
+// ...
+
+```
+
+## Documentation
+
+The documentation for the `bb-api-platforma` API can be found at the following link: [https://betseller.gitlab.io/bb-api-platforma](https://betseller.gitlab.io/bb-api-platforma)