Rainnny/Tether
1
0
Fork 0
Code Issues 1 Pull Requests 2 Actions Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Braydon 2024-09-11 00:45:03 -04:00
parent 14bf786d0b
commit 00ffa59b5c
1 changed files with 61 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -17,7 +17,7 @@
<img src="https://cdn.rainnny.club/tether.png" alt="Tether Logo" width="80" height="80">
</a>
<h3 align="center">Tether</h3>
<h3 align="center">Tether</h3>
<p align="center">
An API designed to provide real-time access to a user's Discord data.
<br />
@ -32,24 +32,27 @@
<!-- Table of Contents -->
## 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 -->
## Features
- [ ] ...
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- Roadmap -->
## 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.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- Contributing -->
## 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:
<a href="https://github.com/Rainnny7/Tether/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Rainnny7/Tether" alt="Top Tether Contributors" />
</a>
@ -72,7 +80,29 @@ you can open an issue with the "enhancement" tag. Don't forget to star the proje
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- License -->
## License
Distributed under the MIT License. See <a href="https://git.rainnny.club/Rainnny/Tether/src/branch/master/LICENSE.md">LICENSE.md</a> for more information.
Distributed under the MIT License. See <a href="https://git.rainnny.club/Rainnny/Tether/src/branch/master/LICENSE.md">
LICENSE.md</a> for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- Self Hosting -->
## Self Hosting
Soon...
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- Used By -->
## 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)
<p align="right">(<a href="#readme-top">back to top</a>)</p>