Showing
1 changed file
with
210 additions
and
0 deletions
README.md
0 → 100644
| 1 | +<div id="top"></div> | ||
| 2 | + | ||
| 3 | + | ||
| 4 | +<!-- PROJECT SHIELDS --> | ||
| 5 | +[![Contributors][contributors-shield]][contributors-url] | ||
| 6 | +[![Forks][forks-shield]][forks-url] | ||
| 7 | +[![Stargazers][stars-shield]][stars-url] | ||
| 8 | +[![Issues][issues-shield]][issues-url] | ||
| 9 | +[![MIT License][license-shield]][license-url] | ||
| 10 | +[![LinkedIn][linkedin-shield]][linkedin-url] | ||
| 11 | + | ||
| 12 | + | ||
| 13 | + | ||
| 14 | +<!-- PROJECT LOGO --> | ||
| 15 | +<br /> | ||
| 16 | +<div align="center"> | ||
| 17 | + <a href="https://github.com/github_username/repo_name"> | ||
| 18 | + <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| 19 | + </a> | ||
| 20 | + | ||
| 21 | +<h3 align="center">Youtub-Comment-Seperator</h3> | ||
| 22 | + | ||
| 23 | + <p align="center"> | ||
| 24 | + Find korean comments between english comments! | ||
| 25 | + <br /> | ||
| 26 | + <a href="http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator"><strong>Explore the docs »</strong></a> | ||
| 27 | + <br /> | ||
| 28 | + <br /> | ||
| 29 | + <a href="http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator">View Demo</a> | ||
| 30 | + · | ||
| 31 | + <a href="http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator/issues">Report Bug</a> | ||
| 32 | + · | ||
| 33 | + <a href="http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator/issues">Request Feature</a> | ||
| 34 | + </p> | ||
| 35 | +</div> | ||
| 36 | + | ||
| 37 | + | ||
| 38 | + | ||
| 39 | +<!-- TABLE OF CONTENTS --> | ||
| 40 | +<details> | ||
| 41 | + <summary>Table of Contents</summary> | ||
| 42 | + <ol> | ||
| 43 | + <li> | ||
| 44 | + <a href="#about-the-project">About The Project</a> | ||
| 45 | + <ul> | ||
| 46 | + <li><a href="#built-with">Built With</a></li> | ||
| 47 | + </ul> | ||
| 48 | + </li> | ||
| 49 | + <li> | ||
| 50 | + <a href="#getting-started">Getting Started</a> | ||
| 51 | + <ul> | ||
| 52 | + <li><a href="#prerequisites">Prerequisites</a></li> | ||
| 53 | + <li><a href="#installation">Installation</a></li> | ||
| 54 | + </ul> | ||
| 55 | + </li> | ||
| 56 | + <li><a href="#usage">Usage</a></li> | ||
| 57 | + <li><a href="#roadmap">Roadmap</a></li> | ||
| 58 | + <li><a href="#contributing">Contributing</a></li> | ||
| 59 | + <li><a href="#license">License</a></li> | ||
| 60 | + <li><a href="#contact">Contact</a></li> | ||
| 61 | + <li><a href="#acknowledgments">Acknowledgments</a></li> | ||
| 62 | + </ol> | ||
| 63 | +</details> | ||
| 64 | + | ||
| 65 | + | ||
| 66 | + | ||
| 67 | +<!-- ABOUT THE PROJECT --> | ||
| 68 | +## About The Project | ||
| 69 | + | ||
| 70 | +[![Product Name Screen Shot][product-screenshot]](https://example.com) | ||
| 71 | + | ||
| 72 | +Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description` | ||
| 73 | + | ||
| 74 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 75 | + | ||
| 76 | + | ||
| 77 | + | ||
| 78 | +### Built With | ||
| 79 | + | ||
| 80 | +<img src="https://img.shields.io/badge/JavaScript-F7DF1E?style=flat-square&logo=javascript&logoColor=white"/> | ||
| 81 | +<img src="https://img.shields.io/badge/Node.js-339933?style=flat-square&logo=node.js&logoColor=white&"/> | ||
| 82 | +<img src="https://img.shields.io/badge/npm-CB3837?style=flat-square&logo=npm&logoColor=white&"/> | ||
| 83 | + | ||
| 84 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 85 | + | ||
| 86 | + | ||
| 87 | + | ||
| 88 | +<!-- GETTING STARTED --> | ||
| 89 | +## Getting Started | ||
| 90 | + | ||
| 91 | +This is an example of how you may give instructions on setting up your project locally. | ||
| 92 | +To get a local copy up and running follow these simple example steps. | ||
| 93 | + | ||
| 94 | +### Prerequisites | ||
| 95 | + | ||
| 96 | +This is an example of how to list things you need to use the software and how to install them. | ||
| 97 | +* npm | ||
| 98 | + ```sh | ||
| 99 | + npm install npm@latest -g | ||
| 100 | + ``` | ||
| 101 | + | ||
| 102 | +### Installation | ||
| 103 | + | ||
| 104 | +1. Get a free API Key at [https://console.cloud.google.com](https://console.cloud.google.com/marketplace/product/google/youtube.googleapis.com?q=search&referrer=search&project=eighth-keyword-349614&supportedpurview=project) | ||
| 105 | +2. Clone the repo | ||
| 106 | + ```sh | ||
| 107 | + git clone http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator.git | ||
| 108 | + ``` | ||
| 109 | +3. Install NPM packages | ||
| 110 | + ```sh | ||
| 111 | + npm install | ||
| 112 | + ``` | ||
| 113 | +4. Enter your API in `config.js` | ||
| 114 | + ```js | ||
| 115 | + const API_KEY = 'ENTER YOUR API'; | ||
| 116 | + ``` | ||
| 117 | + | ||
| 118 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 119 | + | ||
| 120 | + | ||
| 121 | + | ||
| 122 | +<!-- USAGE EXAMPLES --> | ||
| 123 | +## Usage | ||
| 124 | + | ||
| 125 | +Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. | ||
| 126 | + | ||
| 127 | +_For more examples, please refer to the [Documentation](https://example.com)_ | ||
| 128 | + | ||
| 129 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 130 | + | ||
| 131 | + | ||
| 132 | + | ||
| 133 | +<!-- ROADMAP --> | ||
| 134 | +## Roadmap | ||
| 135 | + | ||
| 136 | +- [ ] Feature 1 | ||
| 137 | +- [ ] Feature 2 | ||
| 138 | +- [ ] Feature 3 | ||
| 139 | + - [ ] Nested Feature | ||
| 140 | + | ||
| 141 | +See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues). | ||
| 142 | + | ||
| 143 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 144 | + | ||
| 145 | + | ||
| 146 | + | ||
| 147 | +<!-- CONTRIBUTING --> | ||
| 148 | +## Contributing | ||
| 149 | + | ||
| 150 | +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
| 151 | + | ||
| 152 | +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". | ||
| 153 | +Don't forget to give the project a star! Thanks again! | ||
| 154 | + | ||
| 155 | +1. Fork the Project | ||
| 156 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 157 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 158 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 159 | +5. Open a Pull Request | ||
| 160 | + | ||
| 161 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 162 | + | ||
| 163 | + | ||
| 164 | + | ||
| 165 | +<!-- LICENSE --> | ||
| 166 | +## License | ||
| 167 | + | ||
| 168 | +Distributed under the MIT License. See `LICENSE.txt` for more information. | ||
| 169 | + | ||
| 170 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 171 | + | ||
| 172 | + | ||
| 173 | + | ||
| 174 | +<!-- CONTACT --> | ||
| 175 | +## Contact | ||
| 176 | + | ||
| 177 | +Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com | ||
| 178 | + | ||
| 179 | +Project Link: [http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator](http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator) | ||
| 180 | + | ||
| 181 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 182 | + | ||
| 183 | + | ||
| 184 | + | ||
| 185 | +<!-- ACKNOWLEDGMENTS --> | ||
| 186 | +## Acknowledgments | ||
| 187 | + | ||
| 188 | +* []() | ||
| 189 | +* []() | ||
| 190 | +* []() | ||
| 191 | + | ||
| 192 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
| 193 | + | ||
| 194 | + | ||
| 195 | + | ||
| 196 | +<!-- MARKDOWN LINKS & IMAGES --> | ||
| 197 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| 198 | +[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge | ||
| 199 | +[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors | ||
| 200 | +[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge | ||
| 201 | +[forks-url]: https://github.com/github_username/repo_name/network/members | ||
| 202 | +[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge | ||
| 203 | +[stars-url]: https://github.com/github_username/repo_name/stargazers | ||
| 204 | +[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge | ||
| 205 | +[issues-url]: https://github.com/github_username/repo_name/issues | ||
| 206 | +[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge | ||
| 207 | +[license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt | ||
| 208 | +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 | ||
| 209 | +[linkedin-url]: https://linkedin.com/in/linkedin_username | ||
| 210 | +[product-screenshot]: images/screenshot.png |
-
Please register or login to post a comment