Update README.md
This commit is contained in:
parent
5c54ebc3f6
commit
101a6c79d3
86
README.md
86
README.md
@ -1,7 +1,81 @@
|
||||
# Tether
|
||||
An API designed to provide real-time access to a user's Discord data.
|
||||
<a id="readme-top"></a>
|
||||
|
||||
## TODO
|
||||
- [x] Caching
|
||||
- [x] WebSockets
|
||||
- [x] User account for extra data? (about me, connections, etc)
|
||||
<!-- Shields -->
|
||||
[![Contributors][contributors-shield]][contributors-url]
|
||||
[![Forks][forks-shield]][forks-url]
|
||||
[![Stargazers][stars-shield]][stars-url]
|
||||
[![Issues][issues-shield]][issues-url]
|
||||
[![MIT License][license-shield]][license-url]
|
||||
[![LinkedIn][linkedin-shield]][linkedin-url]
|
||||
|
||||
[![Discord](https://discord.com/api/guilds/1282396166419648656/widget.png)](https://discord.usetether.rest)
|
||||
[![Docs](https://img.shields.io/badge/Docs-darkgreen.svg)](https://git.rainnny.club/Rainnny/Tether/wiki)
|
||||
|
||||
<!-- Greeting -->
|
||||
<br />
|
||||
<div align="center">
|
||||
<a href="https://github.com/othneildrew/Best-README-Template">
|
||||
<img src="images/tether.png" alt="Tether Logo" width="80" height="80">
|
||||
</a>
|
||||
|
||||
<h1 align="center">Tether</h1>
|
||||
<p align="center">
|
||||
An API designed to provide real-time access to a user's Discord data.
|
||||
<br />
|
||||
<a href="/wiki"><strong>Explore the docs »</strong></a>
|
||||
<br />
|
||||
<br />
|
||||
<a href="https://api.usetether.rest/user/504147739131641857">View Demo</a>
|
||||
·
|
||||
<a href="/issues/new">Report Bug</a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<!-- Table of Contents -->
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Features](#features)
|
||||
2. [Roadmap](#roadmap)
|
||||
3. [Contributing](#contributing)
|
||||
4. [License](#license)
|
||||
|
||||
<!-- Features -->
|
||||
## Features
|
||||
- [ ] ...
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
<!-- Roadmap -->
|
||||
## Roadmap
|
||||
- [ ] ...
|
||||
|
||||
<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
|
||||
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!
|
||||
|
||||
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
|
||||
|
||||
### 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>
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||
|
||||
<!-- License -->
|
||||
## License
|
||||
Distributed under the MIT License. See `LICENSE.md` for more information.
|
||||
|
||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
Loading…
x
Reference in New Issue
Block a user