김건우

Update README.md

# 디스코드 스터디 챗봇
>디스코드 상에서 스터디 진행할 수 있는 툴.
<div id="top"></div>
<!--
*** 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".
*** Don't forget to give the project a star!
*** 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 />
<div align="center">
<a href="http://khuhub.khu.ac.kr/2020104050/studyChatBot.git">
<img src="images/logo.jpg" alt="Logo" width="80" height="80">
</a>
<h3 align="center">디스코드 스터디 챗봇</h3>
<p align="center">
디스코드 상에서 스터디 진행할 수 있는 툴
<br />
<a href="http://khuhub.khu.ac.kr/2020104050/studyChatBot.git"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://discord.com/oauth2/authorize?client_id=907956665113018408&permissions=8&scope=bot">View Demo</a>
·
<a href="http://khuhub.khu.ac.kr/2020104050/studyChatBot/issues">Report Bug</a>
·
<a href="http://khuhub.khu.ac.kr/2020104050/studyChatBot/issues">Request Feature</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<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="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
<br/>
## About The Project
------------------
### 개요
~ 공부합시다 우리 ~<br/>
......@@ -33,39 +107,36 @@
<br/>
<p align="right">(<a href="#top">back to top</a>)</p>
### Built With
+ Node.js
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
* [Node.js](https://nodejs.org/en/)
* [discord.js](https://discord.js.org/)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
----------------------------
* 이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 [디스코드를 설치](https://discord.com/)해 주신 후 다음의 과정을 진행해주시기 바랍니다.
* [**여기**](https://discord.com/api/oauth2/authorize?client_id=907956665113018408&permissions=8&scope=bot)를 클릭하여 챗봇을 서버에 초대하시기 바랍니다.<br/>(본인이 관리자인 서버에서만 초대 가능)
### Prerequisites
### Module Installation
This is an example of how to list things you need to use the software and how to install them.
+ discord.js
```
npm install discord.js@12.5.3
```
+ moment
```
npm install --save moment
```
+ simple-youtube-api
```
npm install simple-youtube-api
```
+ ytdl-core
```
npm install ytdl-core
```
+ ffmpeg-binaries
```
npm install --save ffmpeg-binaries
```
* npm
```sh
npm install
```
### API Installation
......@@ -84,56 +155,114 @@ config.json
```
<br/>
<!-- USAGE EXAMPLES -->
## Usage
------------------------
-------------------
### 명령어
<br/>
+ ~ping<br/>쿠옹이와 탁구를 칩니다.
+ ~현재시간<br/>현재시간을 알려줍니다.
+ ~공부시작<br/>공부 시작!<br/>스톱워치가 켜집니다.
+ ~공부끝<br/>공부 끝!<br/>스톱워치가 멈춥니다.
+ ~순위<br/>공부한 시간 순위를 알려줍니다.
+ ~디데이설정 ① ②<br/>디데이를 설정합니다.<br/>① : 이벤트이름<br/>② : 이벤트날짜 (mm/dd)<br/>ex) ~디데이설정 기말고사 12/15
+ ~디데이보기<br/>설정된 디데이를 보여줍니다.
+ ~디데이삭제 ①<br/>입력한 이벤트를 삭제합니다.<br/>① : 이벤트이름<br/>ex) ~디데이삭제 기말고사
+ ~재생 ①<br/>①을 재생합니다.<br/>① : 노래제목<br/>(먼저 음성채널에 입장해야합니다)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ROADMAP -->
## Roadmap
----------------
<br/>
- [x] Add Changelog
- [x] Add back to top links
- [ ] Add Additional Templates w/ Examples
- [ ] Add "components" document to easily copy & paste sections of the readme
- [ ] Multi-language Support
- [ ] Chinese
- [ ] Spanish
See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## Contributing
-----------------
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
<br/>
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
## License
---------------
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#top">back to top</a>)</p>
MIT License
Copyright (c) 2021 김건우
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
<!-- LICENSE -->
## License
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
Distributed under the MIT License. See `LICENSE.txt` for more information.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
<p align="right">(<a href="#top">back to top</a>)</p>
<br/>
<!-- CONTACT -->
## Contact
------------------
김건우 - kgu0515@khu.ac.kr
Project Link: [http://khuhub.khu.ac.kr/2020104050/studyChatBot.git](http://khuhub.khu.ac.kr/2020104050/studyChatBot.git)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
* [Malven's Grid Cheatsheet](https://grid.malven.co/)
* [Img Shields](https://shields.io)
* [GitHub Pages](https://pages.github.com)
* [Font Awesome](https://fontawesome.com)
* [React Icons](https://react-icons.github.io/react-icons/search)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- 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
......