Showing
1 changed file
with
26 additions
and
46 deletions
... | @@ -28,7 +28,7 @@ | ... | @@ -28,7 +28,7 @@ |
28 | <img src="images/logo.jpg" alt="Logo" width="80" height="80"> | 28 | <img src="images/logo.jpg" alt="Logo" width="80" height="80"> |
29 | </a> | 29 | </a> |
30 | 30 | ||
31 | - <h3 align="center">디스코드 스터디 챗봇</h3> | 31 | + <h3 align="center">Discord ChatBot for Study</h3> |
32 | 32 | ||
33 | <p align="center"> | 33 | <p align="center"> |
34 | 디스코드 상에서 스터디 진행할 수 있는 툴 | 34 | 디스코드 상에서 스터디 진행할 수 있는 툴 |
... | @@ -68,7 +68,6 @@ | ... | @@ -68,7 +68,6 @@ |
68 | <li><a href="#contributing">Contributing</a></li> | 68 | <li><a href="#contributing">Contributing</a></li> |
69 | <li><a href="#license">License</a></li> | 69 | <li><a href="#license">License</a></li> |
70 | <li><a href="#contact">Contact</a></li> | 70 | <li><a href="#contact">Contact</a></li> |
71 | - <li><a href="#acknowledgments">Acknowledgments</a></li> | ||
72 | </ol> | 71 | </ol> |
73 | </details> | 72 | </details> |
74 | 73 | ||
... | @@ -79,27 +78,22 @@ | ... | @@ -79,27 +78,22 @@ |
79 | 78 | ||
80 | ![Product Name Screen Shot][product-screenshot] | 79 | ![Product Name Screen Shot][product-screenshot] |
81 | 80 | ||
82 | -### 개요 | ||
83 | -~ 공부합시다 우리 ~<br/> | ||
84 | -블라블라 | ||
85 | - | ||
86 | ### 핵심기능 | 81 | ### 핵심기능 |
87 | 82 | ||
88 | -1. **오늘 얼마나 공부했는지 (시간, 공부시작, 공부중지, 등)<br/>** | 83 | +1. **StopWatch 기능<br/>** |
89 | - + 어제보다 얼마나 공부했는지<br/> | 84 | + + 공부한 시간을 기록하고 어제보다 더 나은 오늘을, 오늘보다 더 나은 내일을 만들어 보아요! |
90 | - + 주간 평균, 한달 평균 공부 시간<br/> | ||
91 | <br/> | 85 | <br/> |
92 | -2. **공부시간 순위<br/>** | 86 | + |
93 | - + 일간 순위<br/> | 87 | +2. **공부시간 순위 확인<br/>** |
94 | - + 주간 순위<br/> | 88 | + + 스터디멤버들과 함께 경쟁하며 발전해보아요! |
95 | <br/> | 89 | <br/> |
90 | + | ||
96 | 3. **D-day 기능<br/>** | 91 | 3. **D-day 기능<br/>** |
92 | + + 중요한 이벤트를 기록하고 스터디멤버들과 공유해보아요! | ||
97 | <br/> | 93 | <br/> |
98 | -4. 음악 재생 기능 | ||
99 | - | ||
100 | -+ 공부에 집중되는 백색소음 재생 기능<br/> | ||
101 | -+ 유튜브에서 원하는 노래 재생 기능 | ||
102 | 94 | ||
95 | +4. **음악 재생 기능<br/>** | ||
96 | + + 같이 공부하는 스터디 멤버들과 한 공간에 함께 있는듯한 느낌을 가져보아요! | ||
103 | <br/> | 97 | <br/> |
104 | 98 | ||
105 | <p align="right">(<a href="#top">back to top</a>)</p> | 99 | <p align="right">(<a href="#top">back to top</a>)</p> |
... | @@ -108,8 +102,6 @@ | ... | @@ -108,8 +102,6 @@ |
108 | 102 | ||
109 | ### Built With | 103 | ### Built With |
110 | 104 | ||
111 | -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. | ||
112 | - | ||
113 | * [Node.js](https://nodejs.org/en/) | 105 | * [Node.js](https://nodejs.org/en/) |
114 | * [discord.js](https://discord.js.org/) | 106 | * [discord.js](https://discord.js.org/) |
115 | 107 | ||
... | @@ -123,13 +115,9 @@ This section should list any major frameworks/libraries used to bootstrap your p | ... | @@ -123,13 +115,9 @@ This section should list any major frameworks/libraries used to bootstrap your p |
123 | 115 | ||
124 | * 이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 [디스코드를 설치](https://discord.com/)해 주신 후 다음의 과정을 진행해주시기 바랍니다. | 116 | * 이 챗봇 프로그램은 디스코드 상에서 동작합니다. 먼저 [디스코드를 설치](https://discord.com/)해 주신 후 다음의 과정을 진행해주시기 바랍니다. |
125 | 117 | ||
126 | -### Prerequisites | 118 | +### Library Installation |
127 | - | ||
128 | -This is an example of how to list things you need to use the software and how to install them. | ||
129 | 119 | ||
130 | - | 120 | +* ``` |
131 | -* npm | ||
132 | - ``` | ||
133 | npm install | 121 | npm install |
134 | ``` | 122 | ``` |
135 | 123 | ||
... | @@ -156,8 +144,6 @@ config.json | ... | @@ -156,8 +144,6 @@ config.json |
156 | 144 | ||
157 | ------------------- | 145 | ------------------- |
158 | 146 | ||
159 | -### 명령어 | ||
160 | - | ||
161 | 147 | ||
162 | + ~ping<br/>쿠옹이와 탁구를 칩니다. | 148 | + ~ping<br/>쿠옹이와 탁구를 칩니다. |
163 | + ~현재시간<br/>현재시간을 알려줍니다. | 149 | + ~현재시간<br/>현재시간을 알려줍니다. |
... | @@ -176,16 +162,16 @@ config.json | ... | @@ -176,16 +162,16 @@ config.json |
176 | <!-- ROADMAP --> | 162 | <!-- ROADMAP --> |
177 | ## Roadmap | 163 | ## Roadmap |
178 | 164 | ||
179 | -- [x] Discord API 연동 | 165 | +- [x] Link Discord API |
180 | - - [x] Discord ChatBot 구현 through discord.js | 166 | + - [x] Implement Discord ChatBot through discord.js |
181 | -- [x] StopWatch 구현 | 167 | +- [x] Implement StopWatch |
182 | - - [x] StudyTime Ranking 구현 | 168 | + - [x] Implement StudyTime Ranking |
183 | -- [x] dDay 구현 | 169 | +- [x] Implement dDay |
184 | -- [x] Youtube API 연동 | 170 | +- [x] Link Youtube API |
185 | - - [x] Music Play Function in Discord Bot 구현 | 171 | + - [x] Implement Music Play Function in Discord Bot |
186 | -- [x] AWS EC2 활용 | 172 | +- [x] Using AWS EC2 |
187 | - [x] Amazon Cloud Server Hosting | 173 | - [x] Amazon Cloud Server Hosting |
188 | - - [x] DiscordBot Demo online for 24/7 구현 | 174 | + - [x] Always run DiscordBot demo |
189 | 175 | ||
190 | See the [open issues](http://khuhub.khu.ac.kr/2020104050/studyChatBot/issues) for a full list of proposed features (and known issues). | 176 | See the [open issues](http://khuhub.khu.ac.kr/2020104050/studyChatBot/issues) for a full list of proposed features (and known issues). |
191 | 177 | ||
... | @@ -196,9 +182,10 @@ See the [open issues](http://khuhub.khu.ac.kr/2020104050/studyChatBot/issues) fo | ... | @@ -196,9 +182,10 @@ See the [open issues](http://khuhub.khu.ac.kr/2020104050/studyChatBot/issues) fo |
196 | <!-- CONTRIBUTING --> | 182 | <!-- CONTRIBUTING --> |
197 | ## Contributing | 183 | ## Contributing |
198 | 184 | ||
199 | -Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | 185 | +Any contributions you make are **greatly appreciated**. |
186 | + | ||
187 | +If you have a suggestion that would make this better, please fork the repo and create a pull request. | ||
200 | 188 | ||
201 | -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". | ||
202 | Don't forget to give the project a star! Thanks again! | 189 | Don't forget to give the project a star! Thanks again! |
203 | 190 | ||
204 | 1. Fork the Project | 191 | 1. Fork the Project |
... | @@ -223,21 +210,14 @@ Distributed under the MIT License. See `LICENSE.txt` for more information. | ... | @@ -223,21 +210,14 @@ Distributed under the MIT License. See `LICENSE.txt` for more information. |
223 | <!-- CONTACT --> | 210 | <!-- CONTACT --> |
224 | ## Contact | 211 | ## Contact |
225 | 212 | ||
226 | -김건우 - kgu0515@khu.ac.kr | 213 | ++ 김건우 - kgu0515@khu.ac.kr |
227 | 214 | ||
228 | -Project Link: [http://khuhub.khu.ac.kr/2020104050/studyChatBot.git](http://khuhub.khu.ac.kr/2020104050/studyChatBot.git) | 215 | ++ Project Link: [http://khuhub.khu.ac.kr/2020104050/studyChatBot.git](http://khuhub.khu.ac.kr/2020104050/studyChatBot.git) |
229 | 216 | ||
230 | <p align="right">(<a href="#top">back to top</a>)</p> | 217 | <p align="right">(<a href="#top">back to top</a>)</p> |
231 | 218 | ||
232 | 219 | ||
233 | 220 | ||
234 | -<!-- ACKNOWLEDGMENTS --> | ||
235 | -## Acknowledgments | ||
236 | - | ||
237 | - | ||
238 | - | ||
239 | -<p align="right">(<a href="#top">back to top</a>)</p> | ||
240 | - | ||
241 | 221 | ||
242 | 222 | ||
243 | <!-- MARKDOWN LINKS & IMAGES --> | 223 | <!-- MARKDOWN LINKS & IMAGES --> | ... | ... |
-
Please register or login to post a comment