Docs modified README

Yuncheol Kwak
Commit eccb89bf163a970dbfab67e2405131414737c79a eccb89bf 1 parent 9c4f07cb
Showing 4 changed files with 52 additions and 82 deletions
LICENSE.txt
README.md
images/logo.png
images/screen.png
--- a/LICENSE.txt 0 → 100644
View file @eccb89b
+++ b/LICENSE.txt 0 → 100644
View file @eccb89b
+MIT License
+
+Copyright (c) 2022 Yuncheol Kwak
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.
\ No newline at end of file
--- a/README.md
View file @eccb89b
+++ b/README.md
View file @eccb89b
 <div id="top"></div>
-
-<!-- PROJECT SHIELDS -->
-[![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="https://github.com/github_username/repo_name">
+  <a href="http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator">
     <img src="images/logo.png" alt="Logo" width="80" height="80">
   </a>
 <h3 align="center">Youtub-Comment-Seperator</h3>
   <p align="center">
-    Find korean comments between english comments!
+    Find someone from your country among foreigners!
     <br />
     <a href="http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator"><strong>Explore the docs »</strong></a>
     <br />
@@ -66,20 +55,27 @@
 <!-- ABOUT THE PROJECT -->
 ## About The Project
+<div align="center">
+  <img src="images/screen.png" alt="screenshot">
+</div>
-[![Product Name Screen Shot][product-screenshot]](https://example.com)
+* Select the language for comments you want to find
+* Show comments only the language you choosen
-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`
-<p align="right">(<a href="#top">back to top</a>)</p>
+<p align="right">(<a href="#top">back to top</a>)</p>
-### Built With
+## Built With
+***
 <img src="https://img.shields.io/badge/JavaScript-F7DF1E?style=flat-square&logo=javascript&logoColor=white"/>
 <img src="https://img.shields.io/badge/Node.js-339933?style=flat-square&logo=node.js&logoColor=white&"/>
 <img src="https://img.shields.io/badge/npm-CB3837?style=flat-square&logo=npm&logoColor=white&"/>
+<img src="https://img.shields.io/badge/Bootstrap-7952B3?style=flat-square&logo=bootstrap&logoColor=white&"/>
+<img src="https://img.shields.io/badge/Express-000000?style=flat-square&logo=express&logoColor=white&"/>
+
 <p align="right">(<a href="#top">back to top</a>)</p>
@@ -87,32 +83,30 @@ Here's a blank template to get started: To avoid retyping too much info. Do a se
 <!-- 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.
+Need to get free API Key
-* npm
+* [Google](https://console.cloud.google.com/apis/dashboard) - *Activate YouTube Data API v3*
-  ```sh
+* [Naver](https://developers.naver.com/apps)
-  npm install npm@latest -g
+
-  ```
 ### Installation
-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)
+1. Clone the repo
-2. Clone the repo
    ```sh
    git clone http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator.git
    ```
-3. Install NPM packages
+2. Install NPM packages
    ```sh
    npm install
    ```
-4. Enter your API in `config.js`
+3. Need to Enter your API Keys in `APIs.json`
-   ```js
+   ```json
-   const API_KEY = 'ENTER YOUR API';
+   "youtubeAPI" : "ENTER YOUR GOOGLE API",
+   "papagoClientID" : "ENTER YOUR NAVER ClientID"
+   "papagoClientSecret":"ENTER YOUR NAVER ClientSecret"
    ```
 <p align="right">(<a href="#top">back to top</a>)</p>
@@ -124,38 +118,21 @@ This is an example of how to list things you need to use the software and how to
 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.
-_For more examples, please refer to the [Documentation](https://example.com)_
-
-<p align="right">(<a href="#top">back to top</a>)</p>
-
-<!-- ROADMAP -->
+_For more examples, please refer to the [Documentation](https://example.com)_
-## Roadmap
-
-- [ ] Feature 1
-- [ ] Feature 2
-- [ ] Feature 3
-    - [ ] Nested Feature
-
-See the [open issues](https://github.com/github_username/repo_name/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**.
+If you have a suggestion that would make this better, please fork the repo and create a pull request. 
-
-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!
 1. Fork the Project
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+2. Create your Feature Branch (`git checkout -b feature/feature_name`)
 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the Branch (`git push origin feature/AmazingFeature`)
+4. Push to the Branch (`git push origin feature/feature_name`)
 5. Open a Pull Request
 <p align="right">(<a href="#top">back to top</a>)</p>
@@ -174,37 +151,9 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
 <!-- CONTACT -->
 ## Contact
-Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com
+Yuncheol Kwak - lvbhkwak@khu.ac.kr </br>
+Kyoleen Kwak - 2007kkl@khu.ac.kr
 Project Link: [http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator](http://khuhub.khu.ac.kr/2019102147/youtube-comment-seperator)
 <p align="right">(<a href="#top">back to top</a>)</p>
-
-
-
-<!-- ACKNOWLEDGMENTS -->
-## Acknowledgments
-
-* []()
-* []()
-* []()
-
-<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/github_username/repo_name.svg?style=for-the-badge
-[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
-[forks-url]: https://github.com/github_username/repo_name/network/members
-[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
-[stars-url]: https://github.com/github_username/repo_name/stargazers
-[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
-[issues-url]: https://github.com/github_username/repo_name/issues
-[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
-[license-url]: https://github.com/github_username/repo_name/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/linkedin_username
-[product-screenshot]: images/screenshot.png
--- a/images/logo.png 0 → 100644
View file @eccb89b
+++ b/images/logo.png 0 → 100644
View file @eccb89b
--- a/images/screen.png 0 → 100644
View file @eccb89b
+++ b/images/screen.png 0 → 100644
View file @eccb89b