Skip to content

Commit 8511fb1

Browse files
authored
Merge pull request #1 from wonism/docs/update-readme
πŸ“ update README.md with small fixes
2 parents ace834b + c59ce71 commit 8511fb1

File tree

8 files changed

+58
-4
lines changed

8 files changed

+58
-4
lines changed

β€Ž.eslintrc.jsβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ module.exports = {
3838
indent: off,
3939
'lines-between-class-members': [error, 'always', { exceptAfterSingleLine: true }],
4040
'max-len': [error, 200, { ignoreComments: true }],
41-
'no-console': error,
41+
'no-console': off,
4242
'no-multiple-empty-lines': [error, { max: error, maxEOF: error }],
4343
'no-implicit-coercion': error,
4444
'no-undef': off,
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
**Description**
2+
3+
- Summary :
4+
5+
- Steps to Reproduce :
6+
7+
- Expected Results :
8+
9+
- Actual Results :
10+
11+
- Reproducible Code Snippet or URL or Image :
12+
13+
---
14+
15+
**Environment**
16+
17+
| Version | <!-- Version of `upbit-api-node`--> |
18+
| OS | <!-- OS you use --> |
19+
20+
<!-- You can fill out this table with more detailes -->
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
**Description**
2+
3+
<!-- fill out this -->
4+
As a [ ]
5+
I want to [ ]
6+
7+
<!--
8+
e.g
9+
As a user,
10+
I want to see SMA
11+
-->
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
**Changes proposed**
2+
3+
-
4+
-
5+
6+
**Issue URL**
7+
8+
-

β€Ž.travis.ymlβ€Ž

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
language: node_js
2+
node_js:
3+
- "10"
4+
script: npm run lint && npm run flow

β€ŽREADME.mdβ€Ž

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,22 @@
11
# Upbit API Node
2-
> Api wrapper for Upbit
2+
> API wrapper for Upbit
3+
4+
[![npm version](https://badge.fury.io/js/upbit-api-node.svg)](https://badge.fury.io/js/upbit-api-node)
5+
[![Build Status](https://travis-ci.org/wonism/upbit-api-node.svg)](https://travis-ci.org/wonism/upbit-api-node)
36

47
## Install
58
```
69
$ npm i -S upbit-api-node
710
```
811

12+
## Disclaimer
13+
```
14+
I am not responsible for anything done with this.
15+
You use it at your own risk.
16+
There are no warranties or guarantees expressed or implied.
17+
You assume all responsibility and liability.
18+
```
19+
920
## Quotation APIs
1021
### subscribe(options) => ws
1122
Get websocket instance to subscribe websocket protocol

β€Žpackage-lock.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Žpackage.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "upbit-api-node",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "Upbit API for Node.js",
55
"keywords": [
66
"upbit",

0 commit comments

Comments
Β (0)