백승욱 / movie-reco-chatbot

Go to a project
Toggle navigation Toggle navigation pinning
백승욱
272a62b0 1 parent b6b25a61

Modify README.md

Inline Side-by-side
Showing 2 changed files with 42 additions and 5 deletions
...@@ -15,15 +15,52 @@ ...@@ -15,15 +15,52 @@
15 * [영화진흥위원회 API](https://www.kobis.or.kr) 15 * [영화진흥위원회 API](https://www.kobis.or.kr)
16 * [LINE Messaging API](https://developers.line.biz/en/services/messaging-api/) 16 * [LINE Messaging API](https://developers.line.biz/en/services/messaging-api/)
17 17
18 -## Prerequisites 18 +<!-- GETTING STARTED -->
19 - 19 +## Getting Started
20 -## Installation 20 +
21 - 21 +This is an example of how you may give instructions on setting up your project locally.
22 +To get a local copy up and running follow these simple example steps.
23 +
24 +### Prerequisites
25 +
26 +This is an example of how to list things you need to use the software and how to install them.
27 +* npm
28 + ```sh
29 + npm install npm@latest -g
30 + ```
31 +
32 +### Installation
33 +
34 +_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
35 +
36 +1. Get a free API Key at [https://example.com](https://example.com)
37 +2. Clone the repo
38 + ```sh
39 + git clone https://github.com/your_username_/Project-Name.git
40 + ```
41 +3. Install NPM packages
42 + ```sh
43 + npm install
44 + ```
45 +4. Enter your API in `config.js`
46 + ```js
47 + const API_KEY = 'ENTER YOUR API';
48 + ```
22 49
23 <!-- USAGE EXAMPLES --> 50 <!-- USAGE EXAMPLES -->
24 ## Usage 51 ## Usage
25 52
53 +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.
26 54
55 +<!-- ROADMAP -->
56 +## Roadmap
57 +- [x] Add Changelog
58 +- [x] Add back to top links
59 +- [ ] Add Additional Templates w/ Examples
60 +- [ ] Add "components" document to easily copy & paste sections of the readme
61 +- [ ] Multi-language Support
62 + - [ ] Chinese
63 + - [ ] Spanish
27 64
28 65
29 <!-- CONTRIBUTING --> 66 <!-- CONTRIBUTING -->
...@@ -37,7 +74,7 @@ If you have a suggestion that would make this better, please fork the repo and c ...@@ -37,7 +74,7 @@ If you have a suggestion that would make this better, please fork the repo and c
37 5. Open a Pull Request 74 5. Open a Pull Request
38 75
39 ## License 76 ## License
40 -MIT License 77 +Distributed under the MIT License. See `LICENSE.txt` for more information.
41 78
42 <!-- CONTACT --> 79 <!-- CONTACT -->
43 ## Contact 80 ## Contact
......