From 87fbc43b7e0e4594c7c4752b948b8ca62b2a8c7b Mon Sep 17 00:00:00 2001 From: ev chang Date: Tue, 18 Jun 2024 02:44:26 +0700 Subject: [PATCH] start out readme --- README.md | 24 ++++++++++++------------ src/main/resources/polycrosshair.svg | 8 ++++++++ 2 files changed, 20 insertions(+), 12 deletions(-) create mode 100644 src/main/resources/polycrosshair.svg diff --git a/README.md b/README.md index b603b32..3ee4a19 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -# OneConfigExampleMod +PolyCrosshair Icon -![Powered by OneConfig](https://polyfrost.org/img/cozy_vector.svg) -![Compact Powered by OneConfig](https://polyfrost.org/img/compact_vector.svg) -![Minimal Powered by OneConfig](https://polyfrost.org/img/cozy-minimal_vector.svg) -![Minimal Compact Powered by OneConfig](https://polyfrost.org/img/compact-minimal_vector.svg) +# PolyCrosshair -Example mod implementing OneConfig. +![Compact Powered by OneConfig](https://polyfrost.org/img/compact_vector.svg) ![Dev Workflow Status](https://img.shields.io/github/v/release/Polyfrost/PolyCrosshair.svg?style=for-the-badge&color=1452cc&label=release) -## How to use +A crosshair modification mod + +## Features + +- + +## Gallery + +![settings-page.png](images/settings-page.png) -- Copy the template either by using GitHub's "Use this template" feature or downloading the repo manually. -- **Remove the license named "LICENSE-TEMPLATE" and choose a new one.** -- Refactor the template (specifically, the modid, version and name in the gradle.properties and most of the class names) - to a different name. -- Have fun modding! :D diff --git a/src/main/resources/polycrosshair.svg b/src/main/resources/polycrosshair.svg new file mode 100644 index 0000000..610a8d3 --- /dev/null +++ b/src/main/resources/polycrosshair.svg @@ -0,0 +1,8 @@ + + + + + + + +