# Project Name

Screenshot or gif

**Table Of Contents**
- [Project description](#project-description)
- [Installation](#installation)
- [Example Usage](#example-usage)
- [Build](#build)
- [Contributing](#contributing)
- [Support](#support)
- [Change log](#change-log)
- [Roadmap](#roadmap)
- [Project Status](#project-status)
- [License](#license)

#### Project description:
- Who this project is for?
  - Users? - self-developed
  - Contributors? - open-source
  - Both?
- Main features and what this project aims to accomplish. Background on why it was started and what problem it solves.
- Link to references/technologies used

## Installation

***
**Requirements/Dependencies:**
- list of prerequisites before installing the project
- how to setup dev environment
***

**Mac OSX and Unix/Linux:**
```bash
$ npm install projectname
```

**Windows 10:**
```bash
$ git clone https://github.com/projectname
```

**Linting Support**
```bash
$ ./custom-script parameters
```

**Necessary Code Switches**
```
configuration file changes

setting variables

debug mode / dev environment setup

automated test suites to confirm environment setup properly
```

## Example Usage

```
Code block of useful examples

Show expected output
```

- Links to more sophisticated examples

## Build

Build and deployment steps.

1. Step 1
2. Step 2
3. Step 3

How to build and release a new version (optional).

## Contributing

- steps on how to get started
- any scripts to be run, configuration or variables to be set
- code style
- commits and branching
- pull requests, issues (template/guidelines)
- how to contact team
- link to [CONTRIBUTING.md]()

## Support
- where contributors and users can go to find support/help
- issue tracker, chat room, email

## Change Log

- Record of changes made since previous version (GitHub releases too)
- Give credit to contributors publicly
- link to [CHANGELOG.md]()

## Roadmap

- Ideas for releases in the future

## Project Status

- slowed down or stopped completely
- make explicit request for maintainers

## License

- ownership of the code
- can others use/modify/contribute?
- can others use this code in their work?
- [choose a license](https://choosealicense.com/)

*Author Info:*
- Author Name
  - Twitter: @twitterhandle
  - Email: email@example.com

*Acknowledgements:*
- shoutout others who have contributed