배지승

README.md 추가

Showing 1 changed file with 216 additions and 0 deletions
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Thanks again! Now go create something AMAZING! :D
-->
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
<!-- [![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url] -->
<!-- PROJECT LOGO -->
<br />
<p align="center">
<!-- <a href="https://github.com/othneildrew/Best-README-Template">
<img src="images/logo.png" alt="Logo" width="80" height="80">
</a> -->
<h1 align="center">Coin-trade-assistant</h1>
<!-- <p align="center">
An awesome README template to jumpstart your projects!
<br />
<a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/othneildrew/Best-README-Template">View Demo</a>
·
<a href="https://github.com/othneildrew/Best-README-Template/issues">Report Bug</a>
·
<a href="https://github.com/othneildrew/Best-README-Template/issues">Request Feature</a>
</p> -->
</p>
<!-- TABLE OF CONTENTS -->
## Table of Contents
<details open="open">
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#installation">Installation</a>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
코인과 관련된 유용한 정보를 얻을 수 있다.
* 국내와 해외의 코인 시세 차이 확인
* 최근 거래량이 활발한 코인 확인
* 고래들이 입금한 코인과 코인 액수 확인
### Built With
<!--
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. -->
* [NodeJS](https://nodejs.org/en/)
<!-- GETTING STARTED -->
<!-- ## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps. -->
<!-- ### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install
``` -->
## Installation
1. Get a free API Key at
[WhaleAlert 오픈 API](https://whale-alert.io/),
[LINE CHANNEL iD](https://developers.line.biz/en/),
[바이넌스 오픈 API](https://www.binance.com/ko/support/faq/c-6)
2. Clone the repo
```
git clone http://khuhub.khu.ac.kr/2018102235/Coin-trade-assistant.git
```
3. Install NPM packages
```
npm install
```
4. Enter your API in `apikey.json`
```
{
"line_token" : {Your API key},
"binance_key" : {Your API key}
}
```
Enter your API in `apikeyWhale`
```
{Your API key}
```
<!-- USAGE EXAMPLES -->
## Usage
1. 국내 시세 차이 확인
BTC 시세차익 확인
```
김프 {코인 심볼 ex) BTC, ETC, ...}
```
2. 최근 활발한 거래량 확인
```
거래량 비율
```
3. 고래들의 입금량 확인
고래들의 입금량을 실시간으로 알림받음
```
고래알람
```
알림 해제
```
고래알람해제
```
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b {Feature Name}`)
3. Commit your Changes (`git commit -m 'Add some {Feature Content}'`)
4. Push to the Branch (`git push origin {Feature Name}`)
5. Open a Pull Request
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE` for more information.
<!-- CONTACT -->
## Contact
배지승(2018102193) - [@email](n1mb0606@khu.ac.kr) - n1mb0606@khu.ac.kr
정홍주(2018000000) - [@email]() -
전현진(2018000000) - [@email]() -
Project Link: [http://khuhub.khu.ac.kr/2018102235/Coin-trade-assistant.git](http://khuhub.khu.ac.kr/2018102235/Coin-trade-assistant.git)
<!-- ACKNOWLEDGEMENTS -->
<!-- ## Acknowledgements
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Img Shields](https://shields.io)
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Pages](https://pages.github.com)
* [Animate.css](https://daneden.github.io/animate.css)
* [Loaders.css](https://connoratherton.com/loaders)
* [Slick Carousel](https://kenwheeler.github.io/slick)
* [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll)
* [Sticky Kit](http://leafo.net/sticky-kit)
* [JVectorMap](http://jvectormap.com)
* [Font Awesome](https://fontawesome.com) -->
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
<!-- [contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/othneildrew
[product-screenshot]: images/screenshot.png -->
\ No newline at end of file