Updated README and added LICENSE

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010-2019 Sean Cusack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1 +1,98 @@
-This project is to allow homebrew club members to be given an identifying number/letter to put on their bottles for competitions.
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+    <img src="logo.png" alt="Logo" width="80" height="80">
+
+  <h3 align="center">Wigan Homebrew Club Competition Entry</h3>
+
+  <p align="center">
+    A project to facilitate anonymous entry into Wigan HBC competitions!
+    <br />
+    <br />
+    <a href="https://wiganhomebrew.cusack.cloud/">View Demo</a>
+    ·
+    <a href="https://git.cusack.cloud/acid/wiganhbc-competition/issues">Report Bug</a>
+    ·
+    <a href="https://git.cusack.cloud/acid/wiganhbc-competition/issues">Request Feature</a>
+  </p>
+</p>
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+* [About the Project](#about-the-project)
+  * [Built With](#built-with)
+* [Getting Started](#getting-started)
+  * [Prerequisites](#prerequisites)
+  * [Running The Project](#Running-the-project)
+* [Usage](#usage)
+* [Roadmap](#roadmap)
+* [License](#license)
+* [Contact](#contact)
+* [Acknowledgements](#acknowledgements)
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+![Screen Shot](screenshot.PNG)
+
+This project is to allow homebrew club members to be given an identifying number/letter to put on their bottles for competitions. The goal is to allow all members to take part with no invigilator/organiser required.
+
+### Built With
+This project is built in python and deployed in docker.
+* [Flask](http://flask.pocoo.org/)
+* [Bootstrap](https://getbootstrap.com)
+* [Docker](https://www.docker.com/)
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+### Prerequisites
+
+For development you need to have python3 installed along with pip. You can then set up a virtualenv and install requirements
+```sh
+pip install -r requirements.txt
+```
+### Running the project
+
+A sample Dockerfile is included. Please note that you must supply an HBC_DB_PATH environmental variable. Below is a sample docker compose that can be used after you clone this repo.
+
+```yaml
+version: '3'
+
+services:
+  wiganhomebrew:
+    container_name: wiganhomebrew
+    build: <relative path to repo directory>
+    restart: always
+    environment:
+      - HBC_DB_PATH=/data
+    volumes:
+      - sqlite-database-volume:/data
+    ports:
+      - 5000:5000
+
+volumes:
+  sqlite-database-volume:
+```
+
+
+<!-- ROADMAP -->
+## Roadmap
+
+See the [open issues](https://git.cusack.cloud/acid/wiganhbc-competition/issues) for a list of proposed features (and known issues).
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+
+<!-- CONTACT -->
+## Contact
+
+Sean Cusack - seancusack@gmail.com
+
+Project Link: [https://git.cusack.cloud/acid/wiganhbc-competition](https://git.cusack.cloud/acid/wiganhbc-competition)