diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc56bb3 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ + + +[![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] +[![LinkedIn][linkedin-shield]][linkedin-url] + + +
+

Stewardle

+ +

+ An awesome README template to jumpstart your projects! +
+ View Demo + · + Report Bug + · + Request Feature +

+
+ + +
+ Table of Contents +
    +
  1. + About The Project +
  2. +
  3. Contributing
  4. +
  5. License
  6. +
  7. Contact
  8. +
+
+ + +## About The Project + +

+ +

+ +A Wordle-inspired game designed for the web. Players must guess the randomly selected F1 driver using statistics retrieved from the Ergast API. Created with Express and Node.js. + + +## Contributing + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + + +## License + +Distributed under the MIT License. See `LICENSE.txt` for more information. + + +## Contact + +Your Name - [https://sy.hr/](https://sy.hr/) - mail@rhysbi.shop + +Project Link: [https://github.com/ssyyhhrr/stewardle](https://github.com/ssyyhhrr/stewardle) + + + +[contributors-shield]: https://img.shields.io/github/contributors/ssyyhhrr/stewardle.svg?style=for-the-badge +[contributors-url]: https://github.com/ssyyhhrr/stewardle/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/ssyyhhrr/stewardle.svg?style=for-the-badge +[forks-url]: https://github.com/ssyyhhrr/stewardle/network/members +[stars-shield]: https://img.shields.io/github/stars/ssyyhhrr/stewardle.svg?style=for-the-badge +[stars-url]: https://github.com/ssyyhhrr/stewardle/stargazers +[issues-shield]: https://img.shields.io/github/issues/ssyyhhrr/stewardle.svg?style=for-the-badge +[issues-url]: https://github.com/ssyyhhrr/stewardle/issues +[license-shield]: https://img.shields.io/github/license/ssyyhhrr/stewardle.svg?style=for-the-badge +[license-url]: https://github.com/ssyyhhrr/stewardle/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://www.linkedin.com/in/rhys-bishop-158638214/