diff --git a/examples/README.md b/examples/README.md index 6860449..3da479b 100644 --- a/examples/README.md +++ b/examples/README.md @@ -4,3 +4,10 @@ These samples can be executed using `ts-node`: ``` ts-node ./examples/rest-spot-public.ts ``` + +Samples that require authentication can be edited directly but also support environmental variables. E.g. on mac/unix: +``` +API_KEY_COM="yourkeyhere" API_SECRET_COM="yoursecrethere" API_PASS_COM="yourapipasshere" ts-node examples/rest-trade-futures.ts +``` + +They can also be converted to JavaScript by changing the imports to require & removing any type annotations. diff --git a/package.json b/package.json index 612b84e..7ccf003 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bitget-api", - "version": "0.9.0", + "version": "1.0.0", "description": "Node.js connector for Bitget REST APIs and WebSockets, with TypeScript & integration tests.", "main": "lib/index.js", "types": "lib/index.d.ts",