diff --git a/README.md b/README.md index 8376814..6ca0527 100644 --- a/README.md +++ b/README.md @@ -1 +1,127 @@ -# stratos \ No newline at end of file +
+ + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] + + + + +
+
+ + Logo + + +

Stratos Exam Tracker

+ +

+ This is my A Level Computer Science Project for the OCR NEA component +
+ · + Report Bug + · + Request Feature +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
  2. +
  3. + Getting Started + +
  4. +
  5. Usage
  6. +
  7. Contact
  8. +
+
+ + + +## About The Project + + + +

(back to top)

+ + + +### Built With + +* [Node.js](https://nodejs.org/) +* [Express.js](https://expressjs.com/) +* [Handlebars](https://handlebarsjs.com/) +* [SASS](https://sass-lang.com/) +* [Jest](https://jestjs.io/) + +

(back to top)

+ + + + +## Getting Started + +To get a local copy up and running follow these simple example steps. + +### Prerequisites + +* npm + ```sh + npm install npm@latest -g + ``` + +### Installation + +1. Clone the repo + ```sh + git clone https://github.com/matt-fidd/stratos.git + ``` +2. Install NPM packages + ```sh + npm install + ``` +3. Run gulp script to help set up config files + ```sh + gulp + ``` + +

(back to top)

+ + + +## Contact + +Project Link: [https://github.com/matt-fidd/stratos](https://github.com/matt-fidd/stratos) + +

(back to top)

+ + + + +[contributors-shield]: https://img.shields.io/github/contributors/matt-fidd/stratos.svg?style=for-the-badge +[contributors-url]: https://github.com/matt-fidd/stratos/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/matt-fidd/stratos.svg?style=for-the-badge +[forks-url]: https://github.com/matt-fidd/stratos/network/members +[stars-shield]: https://img.shields.io/github/stars/matt-fidd/stratos.svg?style=for-the-badge +[stars-url]: https://github.com/matt-fidd/stratos/stargazers +[issues-shield]: https://img.shields.io/github/issues/matt-fidd/stratos.svg?style=for-the-badge +[issues-url]: https://github.com/matt-fidd/stratos/issues +[license-shield]: https://img.shields.io/github/license/matt-fidd/stratos.svg?style=for-the-badge +[license-url]: https://github.com/matt-fidd/stratos/blob/master/LICENSE.txt