code/bybit-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme updates

Browse Source
This commit is contained in:
tiagosiebler
2022-06-30 16:27:34 +01:00
parent 28d3ce5ee5
commit c518a85524
4 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.circleci/config.yml
View File

@@ -13,7 +13,7 @@ jobs:
- node-deps-v1-{{ .Branch }}-{{checksum "package-lock.json"}} - node-deps-v1-{{ .Branch }}-{{checksum "package-lock.json"}}
- run: - run:
name: install packages name: install packages
command: npm ci command: npm ci --ignore-scripts
- save_cache: - save_cache:
key: node-deps-v1-{{ .Branch }}-{{checksum "package-lock.json"}} key: node-deps-v1-{{ .Branch }}-{{checksum "package-lock.json"}}
paths: paths:

4
.github/workflows/npmpublish.yml vendored
View File

@@ -40,13 +40,13 @@ jobs:
node-version: 12 node-version: 12
registry-url: https://registry.npmjs.org/ registry-url: https://registry.npmjs.org/
- run: npm ci - run: npm ci --ignore-scripts
if: steps.version-updated.outputs.has-updated if: steps.version-updated.outputs.has-updated
- run: npm run clean - run: npm run clean
if: steps.version-updated.outputs.has-updated if: steps.version-updated.outputs.has-updated
- run: npm run build - run: npm run build
if: steps.version-updated.outputs.has-updated if: steps.version-updated.outputs.has-updated
- run: npm publish - run: npm publish --ignore-scripts
if: steps.version-updated.outputs.has-updated if: steps.version-updated.outputs.has-updated
env: env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}} NODE_AUTH_TOKEN: ${{secrets.npm_token}}

11
README.md
View File

@@ -15,6 +15,17 @@ Node.js connector for the Bybit APIs and WebSockets, with TypeScript & browser s
- Issues? Check the [issues tab](https://github.com/tiagosiebler/bybit-api/issues). - Issues? Check the [issues tab](https://github.com/tiagosiebler/bybit-api/issues).
- Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram. - Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
## Related projects
Check out my related projects:
- Try my connectors:
- [ftx-api](https://www.npmjs.com/package/ftx-api)
- [bybit-api](https://www.npmjs.com/package/bybit-api)
- [binance](https://www.npmjs.com/package/binance)
- Try my misc utilities:
- [orderbooks](https://www.npmjs.com/package/orderbooks)
- Check out my examples:
- [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples)
## Documentation ## Documentation
Most methods accept JS objects. These can be populated using parameters specified by Bybit's API documentation. Most methods accept JS objects. These can be populated using parameters specified by Bybit's API documentation.
- [Bybit API Inverse Documentation](https://bybit-exchange.github.io/docs/inverse/#t-introduction). - [Bybit API Inverse Documentation](https://bybit-exchange.github.io/docs/inverse/#t-introduction).

4
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "bybit-api", "name": "bybit-api",
"version": "2.2.1", "version": "2.2.2",
"description": "Node.js connector for Bybit's REST APIs and WebSockets, with TypeScript & integration tests.", "description": "Node.js connector for Bybit's REST APIs and WebSockets, with TypeScript & integration tests.",
"main": "lib/index.js", "main": "lib/index.js",
"types": "lib/index.d.ts", "types": "lib/index.d.ts",
@@ -11,7 +11,7 @@
"scripts": { "scripts": {
"test": "jest", "test": "jest",
"test:watch": "jest --watch", "test:watch": "jest --watch",
"clean": "rm -rf lib dist", "clean": "rimraf lib dist",
"build": "tsc", "build": "tsc",
"build:clean": "npm run clean && npm run build", "build:clean": "npm run clean && npm run build",
"build:watch": "npm run clean && tsc --watch", "build:watch": "npm run clean && tsc --watch",