Readme-template

# Project title

A little info about your project and/ or overview that explains **what** the project is about.

A short description of the motivation behind the creation and maintenance of the project. This should explain **why** the project exists.



## Build status

Build status of continus integration i.e. travis, appveyor etc. Ex. - 

[![Build Status](https://travis-ci.org/akashnimare/foco.svg?branch=master)](https://travis-ci.org/akashnimare/foco)
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/akashnimare/foco?branch=master&svg=true)](https://ci.appveyor.com/project/akashnimare/foco/branch/master)


## Screenshots

Include logo/demo screenshot etc.


## Features

What makes your project stand out?


## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```

### Setup Dev environment

A step by step series of examples that tell you how to get a development env running

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

End with an example of getting some data out of the system or using it for a little demo


### Deploy the app/software/program

Add additional notes about how to deploy this on a live system



## Contributing

### Code style
If you're using any code style like xo, standard etc. That will help others while contributing to your project. Ex. -

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
 
 
 
### Tech/framework, acknowledgements
Ex. -

<b>Built with</b>
- [Electron](https://electron.atom.io)

### Code Example
Show what the library does as concisely as possible, developers should be able to figure out **how** your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

### API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

### Testing

Describe and show how to run the tests with code examples.


## Authors Contributers
Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contrbuted in this project. 


## License
A short snippet describing the license (MIT, Apache etc)

MIT © [Yourname]()