@cryptorobot.ai/client 0.0.8 → 0.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/readme.client.md +4 -0
- package/readme.md +2 -39
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cryptorobot.ai/client",
|
|
3
|
-
"description": "A
|
|
4
|
-
"version": "0.0.
|
|
3
|
+
"description": "A typed client for the cryptorobot.ai platform",
|
|
4
|
+
"version": "0.0.9",
|
|
5
5
|
"homepage": "",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"feathers"
|
package/readme.client.md
ADDED
package/readme.md
CHANGED
|
@@ -1,41 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @cryptorobot.ai/client
|
|
2
2
|
|
|
3
|
-
> A
|
|
3
|
+
> A client package for the cryptorobot.ai high-frequency cryptocurrency trading platform
|
|
4
4
|
|
|
5
|
-
## About
|
|
6
|
-
|
|
7
|
-
This project uses [Feathers](http://feathersjs.com). An open source framework for building APIs and real-time applications.
|
|
8
|
-
|
|
9
|
-
## Getting Started
|
|
10
|
-
|
|
11
|
-
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
|
|
12
|
-
2. Install your dependencies
|
|
13
|
-
|
|
14
|
-
```
|
|
15
|
-
cd path/to/backend
|
|
16
|
-
npm install
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
3. Start your app
|
|
20
|
-
|
|
21
|
-
```
|
|
22
|
-
npm run compile # Compile TypeScript source
|
|
23
|
-
npm start
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Testing
|
|
27
|
-
|
|
28
|
-
Run `npm test` and all your tests in the `test/` directory will be run.
|
|
29
|
-
|
|
30
|
-
## Scaffolding
|
|
31
|
-
|
|
32
|
-
This app comes with a powerful command line interface for Feathers. Here are a few things it can do:
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
$ npx feathers help # Show all commands
|
|
36
|
-
$ npx feathers generate service # Generate a new Service
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## Help
|
|
40
|
-
|
|
41
|
-
For more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).
|