v1.0.0: stable release for bitget rest apis & websockets

2022-11-22 12:36:47 +00:00
parent be9d6b1d50
commit 1bba614a3f
2 changed files with 8 additions and 1 deletions
--- 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.