1 | # Aspecto
|
2 |
|
3 | Your API is critical for your success and we wat to help you protect it:
|
4 |
|
5 | ![alt text](https://logo.topsight.io/breaking-change-hover.png "Aspecto IDE example")
|
6 |
|
7 |
|
8 | ## How it works
|
9 | - Install this package - it will report to our servers
|
10 | - Install our [VSCode extension](https://marketplace.visualstudio.com/items?itemName=topsight.topsight)
|
11 |
|
12 | This package and the extension will comminucate and if you are about to make a breaking change we will notify you with VSCode
|
13 |
|
14 | For more details check out our [website](https://www.aspecto.io)
|
15 |
|
16 |
|
17 |
|
18 | ---
|
19 | ## Start using
|
20 | #### Install ####
|
21 |
|
22 | ```
|
23 | npm install @aspecto/core
|
24 | ```
|
25 |
|
26 | #### Usage
|
27 |
|
28 | ```
|
29 | const aspecto = require('@aspecto/core').init();
|
30 | ```
|
31 |
|
32 | - In the root folder create a aspecto.json file with {"token" : "-- token goes here --"}
|
33 |
|
34 | - You can get your token from [here](https://app.aspecto.io/)
|
35 |
|
36 |
|
37 |
|
38 |
|