김건우 / studyChatBot

Go to a project
Toggle navigation Toggle navigation pinning
김건우
047cfcbd 1 parent b268dd0b

Update README.md

Inline Side-by-side
Showing 2 changed files with 190 additions and 61 deletions
1 -# 디스코드 스터디 챗봇 1 +<div id="top"></div>
2 - 2 +<!--
3 - 3 +*** Thanks for checking out the Best-README-Template. If you have a suggestion
4 - 4 +*** that would make this better, please fork the repo and create a pull request
5 - 5 +*** or simply open an issue with the tag "enhancement".
6 ->디스코드 상에서 스터디 진행할 수 있는 툴. 6 +*** Don't forget to give the project a star!
7 +*** Thanks again! Now go create something AMAZING! :D
8 +-->
9 +
10 +
11 +
12 +<!-- PROJECT SHIELDS -->
13 +<!--
14 +*** I'm using markdown "reference style" links for readability.
15 +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
16 +*** See the bottom of this document for the declaration of the reference variables
17 +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
18 +*** https://www.markdownguide.org/basic-syntax/#reference-style-links
19 +-->
20 +[![Contributors][contributors-shield]][contributors-url]
21 +[![Forks][forks-shield]][forks-url]
22 +[![Stargazers][stars-shield]][stars-url]
23 +[![Issues][issues-shield]][issues-url]
24 +[![MIT License][license-shield]][license-url]
25 +[![LinkedIn][linkedin-shield]][linkedin-url]
26 +
27 +
28 +
29 +<!-- PROJECT LOGO -->
30 +<br />
31 +<div align="center">
32 + <a href="http://khuhub.khu.ac.kr/2020104050/studyChatBot.git">
33 + <img src="images/logo.jpg" alt="Logo" width="80" height="80">
34 + </a>
35 +
36 + <h3 align="center">디스코드 스터디 챗봇</h3>
37 +
38 + <p align="center">
39 + 디스코드 상에서 스터디 진행할 수 있는 툴
40 + <br />
41 + <a href="http://khuhub.khu.ac.kr/2020104050/studyChatBot.git"><strong>Explore the docs »</strong></a>
42 + <br />
43 + <br />
44 + <a href="https://discord.com/oauth2/authorize?client_id=907956665113018408&permissions=8&scope=bot">View Demo</a>
45 + ·
46 + <a href="http://khuhub.khu.ac.kr/2020104050/studyChatBot/issues">Report Bug</a>
47 + ·
48 + <a href="http://khuhub.khu.ac.kr/2020104050/studyChatBot/issues">Request Feature</a>
49 + </p>
50 +</div>
51 +
52 +
53 +
54 +<!-- TABLE OF CONTENTS -->
55 +<details>
56 + <summary>Table of Contents</summary>
57 + <ol>
58 + <li>
59 + <a href="#about-the-project">About The Project</a>
60 + <ul>
61 + <li><a href="#built-with">Built With</a></li>
62 + </ul>
63 + </li>
64 + <li>
65 + <a href="#getting-started">Getting Started</a>
66 + <ul>
67 + <li><a href="#prerequisites">Prerequisites</a></li>
68 + <li><a href="#installation">Installation</a></li>
69 + </ul>
70 + </li>
71 + <li><a href="#usage">Usage</a></li>
72 + <li><a href="#roadmap">Roadmap</a></li>
73 + <li><a href="#contributing">Contributing</a></li>
74 + <li><a href="#license">License</a></li>
75 + <li><a href="#contact">Contact</a></li>
76 + <li><a href="#acknowledgments">Acknowledgments</a></li>
77 + </ol>
78 +</details>
79 +
80 +
81 +
82 +<!-- ABOUT THE PROJECT -->
83 +## About The Project
7 84
8 -<br/>
9 85
10 -## About The Project
11 -------------------
12 86
13 ### 개요 87 ### 개요
14 ~ 공부합시다 우리 ~<br/> 88 ~ 공부합시다 우리 ~<br/>
...@@ -33,39 +107,36 @@ ...@@ -33,39 +107,36 @@
33 107
34 <br/> 108 <br/>
35 109
110 +<p align="right">(<a href="#top">back to top</a>)</p>
111 +
112 +
113 +
36 ### Built With 114 ### Built With
37 115
38 -+ Node.js 116 +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.
117 +
118 +* [Node.js](https://nodejs.org/en/)
119 +* [discord.js](https://discord.js.org/)
120 +
121 +
122 +<p align="right">(<a href="#top">back to top</a>)</p>
123 +
39 124
125 +
126 +<!-- GETTING STARTED -->
40 ## Getting Started 127 ## Getting Started
41 -----------------------------
42 128
43 * 이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 [디스코드를 설치](https://discord.com/)해 주신 후 다음의 과정을 진행해주시기 바랍니다. 129 * 이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 [디스코드를 설치](https://discord.com/)해 주신 후 다음의 과정을 진행해주시기 바랍니다.
44 130
45 -* [**여기**](https://discord.com/api/oauth2/authorize?client_id=907956665113018408&permissions=8&scope=bot)를 클릭하여 챗봇을 서버에 초대하시기 바랍니다.<br/>(본인이 관리자인 서버에서만 초대 가능) 131 +### Prerequisites
46 132
47 -### Module Installation 133 +This is an example of how to list things you need to use the software and how to install them.
48 134
49 -+ discord.js 135 +
50 -``` 136 +* npm
51 -npm install discord.js@12.5.3 137 + ```sh
52 -``` 138 + npm install
53 -+ moment 139 + ```
54 -```
55 -npm install --save moment
56 -```
57 -+ simple-youtube-api
58 -```
59 -npm install simple-youtube-api
60 -```
61 -+ ytdl-core
62 -```
63 -npm install ytdl-core
64 -```
65 -+ ffmpeg-binaries
66 -```
67 -npm install --save ffmpeg-binaries
68 -```
69 140
70 ### API Installation 141 ### API Installation
71 142
...@@ -84,56 +155,114 @@ config.json ...@@ -84,56 +155,114 @@ config.json
84 ``` 155 ```
85 156
86 157
87 -<br/>
88 158
159 +<!-- USAGE EXAMPLES -->
89 ## Usage 160 ## Usage
90 ------------------------- 161 +
162 +-------------------
91 163
92 ### 명령어 164 ### 명령어
93 165
94 166
95 -<br/> 167 ++ ~ping<br/>쿠옹이와 탁구를 칩니다.
168 ++ ~현재시간<br/>현재시간을 알려줍니다.
169 ++ ~공부시작<br/>공부 시작!<br/>스톱워치가 켜집니다.
170 ++ ~공부끝<br/>공부 끝!<br/>스톱워치가 멈춥니다.
171 ++ ~순위<br/>공부한 시간 순위를 알려줍니다.
172 ++ ~디데이설정 ① ②<br/>디데이를 설정합니다.<br/>① : 이벤트이름<br/>② : 이벤트날짜 (mm/dd)<br/>ex) ~디데이설정 기말고사 12/15
173 ++ ~디데이보기<br/>설정된 디데이를 보여줍니다.
174 ++ ~디데이삭제 ①<br/>입력한 이벤트를 삭제합니다.<br/>① : 이벤트이름<br/>ex) ~디데이삭제 기말고사
175 ++ ~재생 ①<br/>①을 재생합니다.<br/>① : 노래제목<br/>(먼저 음성채널에 입장해야합니다)
176 +
177 +<p align="right">(<a href="#top">back to top</a>)</p>
178 +
96 179
180 +
181 +<!-- ROADMAP -->
97 ## Roadmap 182 ## Roadmap
98 -----------------
99 183
100 -<br/> 184 +- [x] Add Changelog
185 +- [x] Add back to top links
186 +- [ ] Add Additional Templates w/ Examples
187 +- [ ] Add "components" document to easily copy & paste sections of the readme
188 +- [ ] Multi-language Support
189 + - [ ] Chinese
190 + - [ ] Spanish
191 +
192 +See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).
101 193
194 +<p align="right">(<a href="#top">back to top</a>)</p>
195 +
196 +
197 +
198 +<!-- CONTRIBUTING -->
102 ## Contributing 199 ## Contributing
103 ------------------
104 200
201 +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
105 202
106 -<br/> 203 +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".
204 +Don't forget to give the project a star! Thanks again!
107 205
108 -## License 206 +1. Fork the Project
109 ---------------- 207 +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
208 +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
209 +4. Push to the Branch (`git push origin feature/AmazingFeature`)
210 +5. Open a Pull Request
211 +
212 +<p align="right">(<a href="#top">back to top</a>)</p>
110 213
111 -MIT License
112 214
113 -Copyright (c) 2021 김건우
114 215
115 -Permission is hereby granted, free of charge, to any person obtaining a copy 216 +<!-- LICENSE -->
116 -of this software and associated documentation files (the "Software"), to deal 217 +## License
117 -in the Software without restriction, including without limitation the rights
118 -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
119 -copies of the Software, and to permit persons to whom the Software is
120 -furnished to do so, subject to the following conditions:
121 218
122 -The above copyright notice and this permission notice shall be included in all 219 +Distributed under the MIT License. See `LICENSE.txt` for more information.
123 -copies or substantial portions of the Software.
124 220
125 -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 221 +<p align="right">(<a href="#top">back to top</a>)</p>
126 -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
127 -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
128 -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
129 -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
130 -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
131 -SOFTWARE.
132 222
133 223
134 -<br/>
135 224
225 +<!-- CONTACT -->
136 ## Contact 226 ## Contact
137 -------------------
138 227
139 김건우 - kgu0515@khu.ac.kr 228 김건우 - kgu0515@khu.ac.kr
229 +
230 +Project Link: [http://khuhub.khu.ac.kr/2020104050/studyChatBot.git](http://khuhub.khu.ac.kr/2020104050/studyChatBot.git)
231 +
232 +<p align="right">(<a href="#top">back to top</a>)</p>
233 +
234 +
235 +
236 +<!-- ACKNOWLEDGMENTS -->
237 +## Acknowledgments
238 +
239 +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!
240 +
241 +* [Choose an Open Source License](https://choosealicense.com)
242 +* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
243 +* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)
244 +* [Malven's Grid Cheatsheet](https://grid.malven.co/)
245 +* [Img Shields](https://shields.io)
246 +* [GitHub Pages](https://pages.github.com)
247 +* [Font Awesome](https://fontawesome.com)
248 +* [React Icons](https://react-icons.github.io/react-icons/search)
249 +
250 +<p align="right">(<a href="#top">back to top</a>)</p>
251 +
252 +
253 +
254 +<!-- MARKDOWN LINKS & IMAGES -->
255 +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
256 +[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
257 +[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
258 +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
259 +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
260 +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
261 +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
262 +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
263 +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
264 +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
265 +[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
266 +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
267 +[linkedin-url]: https://linkedin.com/in/othneildrew
268 +[product-screenshot]: images/screenshot.png
...\ No newline at end of file ...\ No newline at end of file
......