mirror of
https://github.com/ssyyhhrr/stewardle.git
synced 2025-11-08 10:33:46 -05:00
88 lines
3.6 KiB
Markdown
88 lines
3.6 KiB
Markdown
<a name="readme-top"></a>
|
|
|
|
[![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]
|
|
|
|
<!-- PROJECT LOGO -->
|
|
<div align="center">
|
|
<a href="https://github.com/othneildrew/Best-README-Template">
|
|
<img src="https://raw.githubusercontent.com/ssyyhhrr/stewardle/refs/heads/main/assets/stewardle.png" alt="Logo" width="80" height="80">
|
|
</a>
|
|
<h3 align="center">Stewardle</h3>
|
|
|
|
<p align="center">
|
|
A Wordle-inspired game designed for the web. Players must guess the randomly selected F1 driver using statistics retrieved from the Jolpica API. Created with Express and Node.js.
|
|
<br />
|
|
<a href="https://stewardle.com/">View Demo</a>
|
|
·
|
|
<a href="https://github.com/ssyyhhrr/stewardle/issues">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/ssyyhhrr/stewardle/issues">Request Feature</a>
|
|
</p>
|
|
</div>
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<ol>
|
|
<li>
|
|
<a href="#about-the-project">About The Project</a>
|
|
</li>
|
|
<li><a href="#contributing">Contributing</a></li>
|
|
<li><a href="#license">License</a></li>
|
|
<li><a href="#contact">Contact</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
## About The Project
|
|
|
|
<p float="left">
|
|
<img src="https://raw.githubusercontent.com/ssyyhhrr/stewardle/refs/heads/main/assets/screenshot.png" width="300"/>
|
|
</p>
|
|
|
|
A Wordle-inspired game designed for the web. Players must guess the randomly selected F1 driver using statistics retrieved from the Jolpica API. Created with Express and Node.js.
|
|
|
|
<!-- CONTRIBUTING -->
|
|
## 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 -->
|
|
## License
|
|
|
|
Distributed under the MIT License. See `LICENSE.txt` for more information.
|
|
|
|
<!-- CONTACT -->
|
|
## Contact
|
|
|
|
Rhys Bishop - [https://sy.hr/](https://sy.hr/) - mail@rhysbi.shop
|
|
|
|
Project Link: [https://github.com/ssyyhhrr/stewardle](https://github.com/ssyyhhrr/stewardle)
|
|
|
|
<!-- MARKDOWN LINKS & IMAGES -->
|
|
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
[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/
|