UNPKG

@cfwest/api-client

Version:

Unofficial CrossFire West ApiClient implementation.

github.com/cfna/cfwest-api

cfna/cfwest-api

37 lines (21 loc) • 1.08 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# [Unofficial] CrossFire West ApiClient for Node.js ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/cfna/cfwest-api/Build%20Package%20&%20Run%20Tests/develop) ![npm (scoped)](https://img.shields.io/npm/v/@cfwest/api-client) ![npm](https://img.shields.io/npm/dt/@cfwest/api-client.svg?label=NPM%20Downloads&logo=npm) > Unofficial CrossFire West ApiClient implementation for Node.js **Important Notice:** :construction: This Module is still in development stage and not intended for public usage yet! :construction: ## Getting Started Install the `@cfwest/api-client` package via `yarn` or `npm`: ```bash # add the dependency via yarn yarn add @cfwest/api-client # or via npm npm install --save @cfwest/api-client ``` ## Usage > //TODO: Add usage documentation. ## Api Docs The docs are build via GitHub Actions and always contain the latest documentation built from the `development` branch. [Click here for Api Docs](https://cfna.github.io/cfwest-api) ## License (c) 2019 - 2020 - PDDStudio & Contributors - [MIT Licensed](./LICENSE)