113 lines
3.6 KiB
Markdown
113 lines
3.6 KiB
Markdown
<a name="readme-top"></a>
|
|
|
|
<!-- PROJECT LOGO -->
|
|
<br />
|
|
<div align="center">
|
|
<a href="https://costcodle.com">
|
|
<img src="assets/CD.png" alt="Logo" width="80" height="80">
|
|
</a>
|
|
|
|
<h3 align="center">COSTCODLE</h3>
|
|
|
|
<p align="center">
|
|
A Wordle-esque daily guessing game for Costco food products!
|
|
<br />
|
|
<a href="https://github.com/KermWasTaken/costcodle"><strong>Explore the docs »</strong></a>
|
|
<br />
|
|
<br />
|
|
<a href="https://costcodle.com">View Demo</a>
|
|
·
|
|
<a href="https://github.com/KermWasTaken/costcodle/issues">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/KermWasTaken/costcodle/issues">Request Feature</a>
|
|
</p>
|
|
|
|
[![MIT License][license-shield]][license-url]
|
|
[![LinkedIn][linkedin-shield]][linkedin-url]
|
|
|
|
</div>
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<ol>
|
|
<li>
|
|
<a href="#about-the-project">About The Project</a>
|
|
<ul>
|
|
<li><a href="#built-with">Built With</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#license">License</a></li>
|
|
<li><a href="#contact">Contact</a></li>
|
|
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
## About The Project
|
|
|
|
[![Product Name Screen Shot][product-screenshot]](https://costcodle.com)
|
|
|
|
Guess the COSTCODLE in 6 tries.
|
|
|
|
* Each guess must be a valid price.
|
|
* Incorrect guesses will help guide you to the target price.
|
|
|
|
If you guess within 5% of the target price, you win!
|
|
|
|
A new COSTCODLE is available every day!
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
### Built With
|
|
|
|
* [![HTML][HTML5]][HTML-url]
|
|
* [![CSS][CSS3]][CSS-url]
|
|
* [![JS][JavaScript]][JavaScript-url]
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- LICENSE -->
|
|
## License
|
|
|
|
Distributed under the MIT License. See `LICENSE.txt` for more information.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- CONTACT -->
|
|
## Contact
|
|
|
|
Zachary Kermitz - zakkermitz@gmail.com
|
|
|
|
Project Link: [https://github.com/KermWasTaken/costcodle](https://github.com/KermWasTaken/costcodle)
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
<!-- ACKNOWLEDGMENTS -->
|
|
## Acknowledgments
|
|
|
|
This project would not have been possible without the following resources:
|
|
|
|
* [Costco Food Database](https://costcofdb.com/food-database)
|
|
* [Wordle](https://www.nytimes.com/games/wordle/index.html)
|
|
* [Tradle](https://oec.world/en/tradle/)
|
|
* [Currency Format Input Field by Wade Williams](https://codepen.io/559wade/pen/LRzEjj)
|
|
* [Best-README-Template](https://github.com/othneildrew/Best-README-Template/)
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
<!-- MARKDOWN LINKS & IMAGES -->
|
|
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
[license-shield]: https://img.shields.io/github/license/KermWasTaken/costcodle.svg?style=for-the-badge
|
|
[license-url]: https://github.com/KermWasTaken/costcodle/blob/main/LICENSE
|
|
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
|
|
[linkedin-url]: https://linkedin.com/in/zacharykermitz
|
|
[product-screenshot]: assets/costcodle.png
|
|
[HTML5]: https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white
|
|
[HTML-url]: https://en.wikipedia.org/wiki/HTML
|
|
[CSS3]: https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white
|
|
[CSS-url]: https://en.wikipedia.org/wiki/CSS
|
|
[JavaScript]: https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E
|
|
[JavaScript-url]: https://en.wikipedia.org/wiki/JavaScript
|