From 00ffa59b5cbc0dcdc6f13296a635ebbcf4dfea2c Mon Sep 17 00:00:00 2001 From: Rainnny7 Date: Wed, 11 Sep 2024 00:45:03 -0400 Subject: [PATCH] Update README.md --- README.md | 92 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 61 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 83944ff..43e3de4 100644 --- a/README.md +++ b/README.md @@ -2,54 +2,57 @@
- - Discord - - - Docs - + + Discord + + + Docs +

- - Tether Logo - - -

Tether

+ + Tether Logo + + +

Tether

- An API designed to provide real-time access to a user's Discord data. -
- Explore the docs » -
-
- View Demo - · - Report Bug + An API designed to provide real-time access to a user's Discord data. +
+ Explore the docs » +
+
+ View Demo + · + Report Bug

## Table of Contents + 1. [Features](#features) -2. [Roadmap](#roadmap) -3. [Contributing](#contributing) -4. [License](#license) +2. [Contributing](#contributing) +3. [License](#license) +4. [Self Hosting](#self-hosting) +5. [Showcase](#tether-is-being-used-by) ## Features -- [ ] ... - -

(back to top)

- - -## Roadmap -- [ ] ... +- **Discord Stats Fetching:** Retrieve a wide range of Discord statistics for any user. The REST endpoint provides easy + access to user data, or you can opt for real-time updates using a WebSocket connection. Want even more user data? Join the [Discord](https://discord.usetether.rest)! +- **Client SDKs:** Leverage client SDKs for both Java and JavaScript to seamlessly integrate Discord data fetching into + your + applications. +- **Self-hostable:** Tether is fully self-hostable with a pre-built Docker image, allowing for quick setup and + deployment.

(back to top)

+ ## Contributing Contributions are the heart of the open source community, making it an incredible space for learning, inspiration, and @@ -58,13 +61,18 @@ creativity. Your contributions are highly valued. If you have an idea to improve this project, feel free to fork the repository and submit a pull request. Alternatively, you can open an issue with the "enhancement" tag. Don't forget to star the project! Thank you for your support! +> [!IMPORTANT] +> Pull Requests on **GitHub** will **NOT** be reviewed. Please make a Pull Request +> on [Gitea](https://git.rainnny.club/Rainnny/Tether/pulls). + 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/CoolFeature`) 3. Commit your Changes (`git commit -m "Add some CoolFeature"`) 4. Push to the Branch (`git push origin feature/CoolFeature`) -5. Open a Pull Request +5. Open a [Pull Request](https://git.rainnny.club/Rainnny/Tether/pulls) ### Top contributors: + Top Tether Contributors @@ -72,7 +80,29 @@ you can open an issue with the "enhancement" tag. Don't forget to star the proje

(back to top)

+ ## License -Distributed under the MIT License. See LICENSE.md for more information. + +Distributed under the MIT License. See +LICENSE.md for more information. + +

(back to top)

+ + + +## Self Hosting + +Soon... + +

(back to top)

+ + + +## Tether is being used by... + +Below is a list of websites that are currently using Tether, take a look! + +- [rainnny.club](https://rainnny.club) +- [oknick.club](https://oknick.club)

(back to top)

\ No newline at end of file