Update README.md
This commit is contained in:
parent
14bf786d0b
commit
00ffa59b5c
92
README.md
92
README.md
@ -2,54 +2,57 @@
|
|||||||
|
|
||||||
<!-- Shields -->
|
<!-- Shields -->
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://discord.usetether.rest">
|
<a href="https://discord.usetether.rest">
|
||||||
<img src="https://discord.com/api/guilds/1282396166419648656/widget.png" alt="Discord">
|
<img src="https://discord.com/api/guilds/1282396166419648656/widget.png" alt="Discord">
|
||||||
</a>
|
</a>
|
||||||
<a href="https://git.rainnny.club/Rainnny/Tether/wiki">
|
<a href="https://git.rainnny.club/Rainnny/Tether/wiki">
|
||||||
<img src="https://img.shields.io/badge/Docs-darkgreen.svg" alt="Docs">
|
<img src="https://img.shields.io/badge/Docs-darkgreen.svg" alt="Docs">
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<!-- Greeting -->
|
<!-- Greeting -->
|
||||||
<br />
|
<br />
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://usetether.rest">
|
<a href="https://usetether.rest">
|
||||||
<img src="https://cdn.rainnny.club/tether.png" alt="Tether Logo" width="80" height="80">
|
<img src="https://cdn.rainnny.club/tether.png" alt="Tether Logo" width="80" height="80">
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<h3 align="center">Tether</h3>
|
<h3 align="center">Tether</h3>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
An API designed to provide real-time access to a user's Discord data.
|
An API designed to provide real-time access to a user's Discord data.
|
||||||
<br />
|
<br />
|
||||||
<a href="https://docs.rainnny.club/books/tether"><strong>Explore the docs »</strong></a>
|
<a href="https://docs.rainnny.club/books/tether"><strong>Explore the docs »</strong></a>
|
||||||
<br />
|
<br />
|
||||||
<br />
|
<br />
|
||||||
<a href="https://api.usetether.rest/user/504147739131641857">View Demo</a>
|
<a href="https://api.usetether.rest/user/504147739131641857">View Demo</a>
|
||||||
·
|
·
|
||||||
<a href="https://git.rainnny.club/Rainnny/Tether/issues">Report Bug</a>
|
<a href="https://git.rainnny.club/Rainnny/Tether/issues">Report Bug</a>
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<!-- Table of Contents -->
|
<!-- Table of Contents -->
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
1. [Features](#features)
|
1. [Features](#features)
|
||||||
2. [Roadmap](#roadmap)
|
2. [Contributing](#contributing)
|
||||||
3. [Contributing](#contributing)
|
3. [License](#license)
|
||||||
4. [License](#license)
|
4. [Self Hosting](#self-hosting)
|
||||||
|
5. [Showcase](#tether-is-being-used-by)
|
||||||
|
|
||||||
<!-- Features -->
|
<!-- Features -->
|
||||||
## Features
|
## Features
|
||||||
- [ ] ...
|
- **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)!
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
- **Client SDKs:** Leverage client SDKs for both Java and JavaScript to seamlessly integrate Discord data fetching into
|
||||||
|
your
|
||||||
<!-- Roadmap -->
|
applications.
|
||||||
## Roadmap
|
- **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>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
<!-- Contributing -->
|
<!-- Contributing -->
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions are the heart of the open source community, making it an incredible space for learning, inspiration, and
|
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,
|
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!
|
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
|
1. Fork the Project
|
||||||
2. Create your Feature Branch (`git checkout -b feature/CoolFeature`)
|
2. Create your Feature Branch (`git checkout -b feature/CoolFeature`)
|
||||||
3. Commit your Changes (`git commit -m "Add some CoolFeature"`)
|
3. Commit your Changes (`git commit -m "Add some CoolFeature"`)
|
||||||
4. Push to the Branch (`git push origin feature/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 contributors:
|
||||||
|
|
||||||
<a href="https://github.com/Rainnny7/Tether/graphs/contributors">
|
<a href="https://github.com/Rainnny7/Tether/graphs/contributors">
|
||||||
<img src="https://contrib.rocks/image?repo=Rainnny7/Tether" alt="Top Tether Contributors" />
|
<img src="https://contrib.rocks/image?repo=Rainnny7/Tether" alt="Top Tether Contributors" />
|
||||||
</a>
|
</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>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
<!-- License -->
|
<!-- License -->
|
||||||
|
|
||||||
## 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>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
Loading…
Reference in New Issue
Block a user