├── README.md
└── logo.png


/README.md:
--------------------------------------------------------------------------------
  1 | [![Forks][forks-shield]][forks-url]
  2 | [![Stargazers][stars-shield]][stars-url]
  3 | [![Issues][issues-shield]][issues-url]
  4 | [![LinkedIn][linkedin-shield]][linkedin-url]
  5 | 
  6 | 
  7 | 
  8 | <!-- PROJECT LOGO -->
  9 | <br />
 10 | <p align="center">
 11 |   <a href="https://github.com/roshanlam/ReadMeTemplate/">
 12 |     <img src="./logo.png" alt="Logo" width="80" height="80">
 13 |   </a>
 14 | 
 15 |   <h3 align="center">Read Me Template</h3>
 16 | 
 17 |   <p align="center">
 18 |     A Read Me template for your projects!
 19 |     <br />
 20 |     <a href="https://github.com/roshanlam/ReadMeTemplate/"><strong>Explore the docs »</strong></a>
 21 |     <br />
 22 |     <br />
 23 |     <a href="https://github.com/roshanlam/ReadMeTemplate/">View Demo</a>
 24 |     ·
 25 |     <a href="https://github.com/roshanlam/ReadMeTemplate/issues">Report Bug</a>
 26 |     ·
 27 |     <a href="https://github.com/roshanlam/ReadMeTemplate/issues">Request Feature</a>
 28 |     ·
 29 |     <a href="https://github.com/roshanlam/ReadMeTemplate/pulls">Send a Pull Request</a>
 30 |   </p>
 31 | </p>
 32 | 
 33 | <!-- ABOUT THE PROJECT -->
 34 | ## About The Project
 35 | 
 36 | [![Product Name Screen Shot][product-screenshot]](https://example.com)
 37 | 
 38 | There are many great README templates available on GitHub, however, I didn't find one that really suited 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.
 39 | 
 40 | Here's why:
 41 | * Your time should be focused on creating something amazing. A project that solves a problem and helps others
 42 | * You shouldn't be doing the same tasks over and over like creating a README from scratch
 43 | * You should element DRY principles to the rest of your life :smile:
 44 | 
 45 | 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.
 46 | 
 47 | A list of commonly used resources that I find helpful are listed in the acknowledgements.
 48 | 
 49 | ### Built With
 50 | 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.
 51 | * [Bootstrap](https://getbootstrap.com)
 52 | * [JQuery](https://jquery.com)
 53 | * [Laravel](https://laravel.com)
 54 | 
 55 | 
 56 | 
 57 | <!-- GETTING STARTED -->
 58 | ## Getting Started
 59 | 
 60 | This is an example of how you may give instructions on setting up your project locally.
 61 | To get a local copy up and running follow these simple example steps.
 62 | 
 63 | ### Prerequisites
 64 | 
 65 | This is an example of how to list things you need to use the software and how to install them.
 66 | * npm
 67 | ```sh
 68 | npm install npm@latest -g
 69 | ```
 70 | 
 71 | ### Installation
 72 | 
 73 | 1. Get a free API Key at [https://example.com](https://example.com)
 74 | 2. Clone the repo
 75 | ```sh
 76 | git clone https://github.com/your_username_/Project-Name.git
 77 | ```
 78 | 3. Install NPM packages
 79 | ```sh
 80 | npm install
 81 | ```
 82 | 4. Enter your API in `config.js`
 83 | ```JS
 84 | const API_KEY = 'ENTER YOUR API';
 85 | ```
 86 | 
 87 | 
 88 | 
 89 | <!-- USAGE EXAMPLES -->
 90 | ## Usage
 91 | 
 92 | 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.
 93 | 
 94 | _For more examples, please refer to the [Documentation](https://example.com)_
 95 | 
 96 | 
 97 | 
 98 | <!-- ROADMAP -->
 99 | ## 🚧 Roadmap
100 | 
101 | See the [open issues](https://github.com/roshanlam/ReadMeTemplate/issues) for a list of proposed features (and known issues).
102 | 
103 | 
104 | 
105 | <!-- CONTRIBUTING -->
106 | ## 🤝 Contributing
107 | 
108 | Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **extremely appreciated**.
109 | 
110 | 1. Fork the Project
111 | 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
112 | 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
113 | 4. Push to the Branch (`git push origin feature/AmazingFeature`)
114 | 5. Open a Pull Request
115 | 
116 | 
117 | 
118 | <!-- LICENSE -->
119 | ## 📝 License
120 | Describe your License for your project. 
121 | 
122 | Distributed under the MIT License. See `LICENSE` for more information.
123 | 
124 | 
125 | 
126 | <!-- CONTACT -->
127 | ## 📫 Contact
128 | 
129 | Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
130 | 
131 | Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)
132 | 
133 | 
134 | 
135 | <!-- ACKNOWLEDGEMENTS -->
136 | ## Acknowledgements
137 | * [Img Shields](https://shields.io)
138 | * [GitHub Pages](https://pages.github.com)
139 | * [Font Awesome](https://fontawesome.com)
140 | * blah blah blah....
141 | 
142 | 
143 | 
144 | 
145 | 
146 | <!-- MARKDOWN LINKS & IMAGES -->
147 | <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
148 | [forks-shield]: https://img.shields.io/github/forks/roshanlam/ReadMeTemplate?style=for-the-badge
149 | [forks-url]: https://github.com/roshanlam/ReadMeTemplate/network/members
150 | [stars-shield]: https://img.shields.io/github/stars/roshanlam/ReadMeTemplate?style=for-the-badge
151 | [stars-url]: https://github.com/roshanlam/ReadMeTemplate/stargazers
152 | [issues-shield]: https://img.shields.io/github/issues/roshanlam/ReadMeTemplate?style=for-the-badge
153 | [issues-url]: https://github.com/roshanlam/ReadMeTemplate/issues
154 | [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
155 | [linkedin-url]: https://linkedin.com/in/roshan-lamichhane
156 | 


--------------------------------------------------------------------------------
/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/roshanlam/ReadMeTemplate/9876aed619a8de30b5cdaa831fd221070f6ca08b/logo.png


--------------------------------------------------------------------------------