aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..02eafb1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# skyblock.bingo
+
+skyblock.bingo allows you to view your [Hypixel Skyblock](https://hypixel.net/categories/skyblock.194/) bingo card, share your bingo progress with others, and view guides for how to solve the current bingo challenge!
+
+Website: https://skyblock.bingo
+
+## Features
+
+- View your current bingo card
+- View the goals you have left to complete
+- View guides for how to complete the bingo goals
+- View the top one-hundred bingo players
+- An API for getting a player's bingo stats
+
+![XessDx Bingo](https://user-images.githubusercontent.com/34806109/163301430-cc68de26-3d49-4f1a-9734-a49b68571c51.png)
+
+## Contributing
+
+Open a pull request and I will look into adding the feature!