장주현

add readme.md template

Showing 1 changed file with 205 additions and 0 deletions
...@@ -8,3 +8,208 @@ ...@@ -8,3 +8,208 @@
8 8
9 참고: http://postcode.map.daum.net/guide 9 참고: http://postcode.map.daum.net/guide
10 10
11 +
12 +<!--
13 +*** Thanks for checking out this README Template. If you have a suggestion that would
14 +*** make this better, please fork the repo and create a pull request or simply open
15 +*** an issue with the tag "enhancement".
16 +*** Thanks again! Now go create something AMAZING! :D
17 +-->
18 +
19 +
20 +
21 +
22 +
23 +<!-- PROJECT SHIELDS -->
24 +<!--
25 +*** I'm using markdown "reference style" links for readability.
26 +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
27 +*** See the bottom of this document for the declaration of the reference variables
28 +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
29 +*** https://www.markdownguide.org/basic-syntax/#reference-style-links
30 +-->
31 +[![Contributors][contributors-shield]][contributors-url]
32 +[![Forks][forks-shield]][forks-url]
33 +[![Stargazers][stars-shield]][stars-url]
34 +[![Issues][issues-shield]][issues-url]
35 +[![MIT License][license-shield]][license-url]
36 +[![LinkedIn][linkedin-shield]][linkedin-url]
37 +
38 +
39 +
40 +<!-- PROJECT LOGO -->
41 +<br />
42 +<p align="center">
43 + <a href="https://github.com/othneildrew/Best-README-Template">
44 + <img src="images/logo.png" alt="Logo" width="80" height="80">
45 + </a>
46 +
47 + <h3 align="center">Best-README-Template</h3>
48 +
49 + <p align="center">
50 + An awesome README template to jumpstart your projects!
51 + <br />
52 + <a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
53 + <br />
54 + <br />
55 + <a href="https://github.com/othneildrew/Best-README-Template">View Demo</a>
56 + ·
57 + <a href="https://github.com/othneildrew/Best-README-Template/issues">Report Bug</a>
58 + ·
59 + <a href="https://github.com/othneildrew/Best-README-Template/issues">Request Feature</a>
60 + </p>
61 +</p>
62 +
63 +
64 +
65 +<!-- TABLE OF CONTENTS -->
66 +## Table of Contents
67 +
68 +* [About the Project](#about-the-project)
69 + * [Built With](#built-with)
70 +* [Getting Started](#getting-started)
71 + * [Prerequisites](#prerequisites)
72 + * [Installation](#installation)
73 +* [Usage](#usage)
74 +* [Roadmap](#roadmap)
75 +* [Contributing](#contributing)
76 +* [License](#license)
77 +* [Contact](#contact)
78 +* [Acknowledgements](#acknowledgements)
79 +
80 +
81 +
82 +<!-- ABOUT THE PROJECT -->
83 +## About The Project
84 +
85 +[![Product Name Screen Shot][product-screenshot]](https://example.com)
86 +
87 +There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need.
88 +
89 +Here's why:
90 +* Your time should be focused on creating something amazing. A project that solves a problem and helps others
91 +* You shouldn't be doing the same tasks over and over like creating a README from scratch
92 +* You should element DRY principles to the rest of your life :smile:
93 +
94 +Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.
95 +
96 +A list of commonly used resources that I find helpful are listed in the acknowledgements.
97 +
98 +### Built With
99 +This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
100 +* [Bootstrap](https://getbootstrap.com)
101 +* [JQuery](https://jquery.com)
102 +* [Laravel](https://laravel.com)
103 +
104 +
105 +
106 +<!-- GETTING STARTED -->
107 +## Getting Started
108 +
109 +This is an example of how you may give instructions on setting up your project locally.
110 +To get a local copy up and running follow these simple example steps.
111 +
112 +### Prerequisites
113 +
114 +This is an example of how to list things you need to use the software and how to install them.
115 +* npm
116 +```sh
117 +npm install npm@latest -g
118 +```
119 +
120 +### Installation
121 +
122 +1. Get a free API Key at [https://example.com](https://example.com)
123 +2. Clone the repo
124 +```sh
125 +git clone https://github.com/your_username_/Project-Name.git
126 +```
127 +3. Install NPM packages
128 +```sh
129 +npm install
130 +```
131 +4. Enter your API in `config.js`
132 +```JS
133 +const API_KEY = 'ENTER YOUR API';
134 +```
135 +
136 +
137 +
138 +<!-- USAGE EXAMPLES -->
139 +## Usage
140 +
141 +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.
142 +
143 +_For more examples, please refer to the [Documentation](https://example.com)_
144 +
145 +
146 +
147 +<!-- ROADMAP -->
148 +## Roadmap
149 +
150 +See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a list of proposed features (and known issues).
151 +
152 +
153 +
154 +<!-- CONTRIBUTING -->
155 +## Contributing
156 +
157 +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
158 +
159 +1. Fork the Project
160 +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
161 +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
162 +4. Push to the Branch (`git push origin feature/AmazingFeature`)
163 +5. Open a Pull Request
164 +
165 +
166 +
167 +<!-- LICENSE -->
168 +## License
169 +
170 +Distributed under the MIT License. See `LICENSE` for more information.
171 +
172 +
173 +
174 +<!-- CONTACT -->
175 +## Contact
176 +
177 +Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
178 +
179 +Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
180 +
181 +
182 +
183 +<!-- ACKNOWLEDGEMENTS -->
184 +## Acknowledgements
185 +* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
186 +* [Img Shields](https://shields.io)
187 +* [Choose an Open Source License](https://choosealicense.com)
188 +* [GitHub Pages](https://pages.github.com)
189 +* [Animate.css](https://daneden.github.io/animate.css)
190 +* [Loaders.css](https://connoratherton.com/loaders)
191 +* [Slick Carousel](https://kenwheeler.github.io/slick)
192 +* [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll)
193 +* [Sticky Kit](http://leafo.net/sticky-kit)
194 +* [JVectorMap](http://jvectormap.com)
195 +* [Font Awesome](https://fontawesome.com)
196 +
197 +
198 +
199 +
200 +
201 +<!-- MARKDOWN LINKS & IMAGES -->
202 +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
203 +[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=flat-square
204 +[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors
205 +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=flat-square
206 +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members
207 +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=flat-square
208 +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers
209 +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=flat-square
210 +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
211 +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=flat-square
212 +[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
213 +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
214 +[linkedin-url]: https://linkedin.com/in/othneildrew
215 +[product-screenshot]: images/screenshot.png
......