chore: include README

This commit is contained in:
Erica Marigold 2023-12-08 11:15:52 +05:30 committed by GitHub
parent b14036344d
commit 41267a1b57
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

27
README.md Normal file
View file

@ -0,0 +1,27 @@
<img align="right" height="250" width="250" src="src/main/resources/assets/touch_grass_reminder/icon.png" />
# touch-grass-reminder
<div>
<a href="https://modrinth.com/mod/touch-grass-reminder">
<img alt="modrinth" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg" />
</a>
<a href="https://quiltmc.org">
<img alt="quilt" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/quilt_vector.svg" />
</a>
<a href="https://fabricmc.net">
<img alt="fabric" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg" />
</a>
</div>
<br />
A client-side quilt/fabric mod which warns players when they have been excessively playing Minecraft, to go outside and touch grass. [Studies](https://www.health.harvard.edu/blog/the-health-effects-of-too-much-gaming-2020122221645)
have shown the negative impacts of excessive gaming on the brain.
# Features
- Configurable reminder frequency.
- Togggleable mod functionality.
- Modmenu integration.
##### This mod was inspired by a [recurring joke](https://github.com/CompeyDev/touch-grass-reminder/assets/74418041/a6bbc222-e24e-4b01-a5ae-3645e9080570) in the modrinth discord. lol!