|
3 | 3 | [](https://badge.fury.io/js/%40vultr%2Fvultr-node) |
4 | 4 | [](https://github.com/vultr/vultr-node/blob/master/LICENSE.md) |
5 | 5 |
|
6 | | -# vultr-node |
| 6 | +# cryptfire-node |
7 | 7 |
|
8 | | -Official Vultr client node module. |
| 8 | +Official Cryptfire client node module. |
9 | 9 |
|
10 | 10 | ## Installation |
11 | 11 |
|
12 | 12 | ```sh |
13 | | -npm install @vultr/vultr-node |
| 13 | +npm install @cryptfire/cryptfire-node |
14 | 14 | ``` |
15 | 15 |
|
16 | 16 | ## Usage |
17 | 17 |
|
18 | | -Vultr uses a PAT (Personal Access Token) to interact/authenticate with the APIs. An API Key can be generated and acquired from the API menu in [settings](https://my.vultr.com/settings/#settingsapi). |
| 18 | +An API Key can be generated and acquired with curl, or the Cryptfire CLI. |
19 | 19 |
|
20 | 20 | ### Initialize |
21 | 21 |
|
22 | 22 | ```js |
23 | | -const VultrNode = require('@vultr/vultr-node') |
| 23 | +const cryptfireNode = require('@cryptfire/cryptfire-node') |
24 | 24 |
|
25 | 25 | // Initialize the instance with your configuration |
26 | | -const vultr = VultrNode.initialize({ |
27 | | - apiKey: 'your-api-key-here', |
28 | | - baseUrl: 'https://example.com', // Optional |
29 | | - rateLimit: 600 // Optional |
| 26 | +const cryptfire = cryptfireNode.initialize({ |
| 27 | + apiKey: 'your-api-key-here' |
30 | 28 | }) |
31 | 29 | ``` |
32 | 30 |
|
33 | 31 | ### Calling Endpoints |
34 | 32 |
|
35 | 33 | ```js |
36 | 34 | // Call endpoints using Promises |
37 | | -vultr.account.getAccountInfo().then((response) => { |
| 35 | +cryptfire.account.getAccountInfo().then((response) => { |
38 | 36 | console.log(response) |
39 | 37 | }) |
40 | 38 | ``` |
41 | 39 |
|
42 | | -## Versioning |
43 | | - |
44 | | -This project follows [SemVer](https://semver.org/) for versioning. For the versions available, [see the tags on this repository](https://github.com/vultr/vultr-node/releases) |
45 | | - |
46 | 40 | ## Documentation |
47 | 41 |
|
48 | | -This implements Vultr API V2. For documentation on all endpoints, please visit https://www.vultr.com/api/. To use Vultr API V1, please use the version of the library on the [V1 branch](https://github.com/vultr/vultr-node/tree/v1), or any version of this library before 2.0.0. |
| 42 | +This implements Cryptfire API V1. For documentation on all endpoints, please visit https://docs.cryptfire.io/api/. |
49 | 43 |
|
50 | | -For documentation specific to this client please visit https://vultr.github.io/vultr-node |
| 44 | +For documentation specific to this client please visit the Github wiki. |
51 | 45 |
|
52 | 46 | ## Contributing |
53 | 47 |
|
|
0 commit comments