Skip to content

Commit ace834b

Browse files
committed
📝 add some descriptions in README.md
- how to install - how to acquire keys to use exchange API
1 parent 6ee5773 commit ace834b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

‎README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Upbit API Node
22
> Api wrapper for Upbit
33
4+
## Install
5+
```
6+
$ npm i -S upbit-api-node
7+
```
8+
49
## Quotation APIs
510
### subscribe(options) => ws
611
Get websocket instance to subscribe websocket protocol
@@ -80,6 +85,8 @@ const upbitExchange = new Exchange(ACCESS_KEY, SECRET_KEY);
8085
| accessKey | String | n\a |
8186
| secretKey | String | n\a |
8287

88+
- You should go to [Open API Management page](https://upbit.com/mypage/open_api_management) to acquire these keys.
89+
8390
### upbitExchange.getMyAssets() => Promise
8491
Get user's asset information
8592

0 commit comments

Comments
 (0)