From d420cb4e49314e65835ed6885fd07a1f51774dde Mon Sep 17 00:00:00 2001 From: Tiago Siebler Date: Wed, 3 Apr 2024 19:05:07 +0100 Subject: [PATCH] v2.0.0: trigger release --- .github/workflows/npmpublish.yml | 2 +- README.md | 58 +++++++++++++++++--------------- package.json | 4 +-- 3 files changed, 33 insertions(+), 31 deletions(-) diff --git a/.github/workflows/npmpublish.yml b/.github/workflows/npmpublish.yml index 4ca178c..b9837dd 100644 --- a/.github/workflows/npmpublish.yml +++ b/.github/workflows/npmpublish.yml @@ -48,4 +48,4 @@ jobs: - run: npm publish --ignore-scripts --provenance if: steps.version-updated.outputs.has-updated env: - NODE_AUTH_TOKEN: ${{secrets.npm_token}} + NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} diff --git a/README.md b/README.md index 417fd1a..c3ad524 100644 --- a/README.md +++ b/README.md @@ -25,34 +25,6 @@ Complete JavaScript & Node.js SDK for BitMart REST APIs & WebSockets: - Issues? Check the [issues tab](https://github.com/tiagosiebler/bitmart-api/issues). - 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: - - [binance](https://www.npmjs.com/package/binance) - - [bybit-api](https://www.npmjs.com/package/bybit-api) - - [okx-api](https://www.npmjs.com/package/okx-api) - - [bitget-api](https://www.npmjs.com/package/bitget-api) - - [bitmart-api](https://www.npmjs.com/package/bitmart-api) -- Try my misc utilities: - - [orderbooks](https://www.npmjs.com/package/orderbooks) - - [accountstate](https://www.npmjs.com/package/accountstate) -- Check out my examples: - - [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples) - -## Structure - -This connector is fully compatible with both TypeScript and pure JavaScript projects, while the connector is written in TypeScript. A pure JavaScript version can be built using `npm run build`, which is also the version published to [npm](https://www.npmjs.com/package/bitmart-api). - -The version on npm is the output from the `build` command and can be used in projects without TypeScript (although TypeScript is definitely recommended). - -Note: The build will output both ESM and CJS, although node should automatically import the correct entrypoint for your environment. - -- [src](./src) - the whole SDK written in TypeScript -- [dist](./dist) - ESM & CJS builds of the SDK in JavaScript (this is published to npm) -- [examples](./examples) - some implementation examples & demonstrations. - ## Usage Most methods pass values as-is into HTTP requests. These can be populated using parameters specified by BitMart's API documentation, or check the type definition in each class within this repository. @@ -100,6 +72,36 @@ Refer to the [fasterHmacSign.ts](./examples/fasterHmacSign.ts) example for a dem --- +## Related projects + +Check out my related projects: + +- Try my connectors: + - [binance](https://www.npmjs.com/package/binance) + - [bybit-api](https://www.npmjs.com/package/bybit-api) + - [okx-api](https://www.npmjs.com/package/okx-api) + - [bitget-api](https://www.npmjs.com/package/bitget-api) + - [bitmart-api](https://www.npmjs.com/package/bitmart-api) +- Try my misc utilities: + - [orderbooks](https://www.npmjs.com/package/orderbooks) + - [accountstate](https://www.npmjs.com/package/accountstate) +- Check out my examples: + - [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples) + +## Structure + +This connector is fully compatible with both TypeScript and pure JavaScript projects, while the connector is written in TypeScript. A pure JavaScript version can be built using `npm run build`, which is also the version published to [npm](https://www.npmjs.com/package/bitmart-api). + +The version on npm is the output from the `build` command and can be used in projects without TypeScript (although TypeScript is definitely recommended). + +Note: The build will output both ESM and CJS, although node should automatically import the correct entrypoint for your environment. + +- [src](./src) - the whole SDK written in TypeScript +- [dist](./dist) - ESM & CJS builds of the SDK in JavaScript (this is published to npm) +- [examples](./examples) - some implementation examples & demonstrations. + +--- + ## Contributions & Thanks ### Donations diff --git a/package.json b/package.json index d84effd..adf9319 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "bitmart-api", - "version": "2.0.0-beta.0", - "description": "Complete & robust Node.js SDK for BitMart's REST APIs and WebSockets, with TypeScript definitions.", + "version": "2.0.0", + "description": "Complete & robust Node.js SDK for BitMart's REST APIs and WebSockets, with TypeScript declarations.", "scripts": { "build": "rm -fr dist/* && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && bash ./postBuild.sh", "test": "jest --passWithNoTests"