Skip to content

Latest commit

 

History

History
252 lines (180 loc) · 8.38 KB

README.md

File metadata and controls

252 lines (180 loc) · 8.38 KB

THIS IS A PLACEHOLDER README TEMPLATE UNTIL I CAN GET AROUND TO DOING IT...

Contributors Forks Stargazers Issues MIT License


A README Ready to Read...

project_description 

<br />
<a href="https://github.com/github_username/repo_name/issues">Report Bug</a>
·
<a href="https://github.com/github_username/repo_name/issues">Request Feature</a>

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

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

(back to top)

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.

  • npm 
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://example.com
  2. Clone the repo 
    git clone https://github.com/github_username/repo_name.git
  3. Install NPM packages 
    npm install
  4. Enter your API in config.js 
    const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

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

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

See [CONTRIBUTING.md][CONTIBUTING-url] to contribute.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Project Link: https://github.com/github_username/repo_name

(back to top)

Acknowledgments

(back to top)