From 101a6c79d3b0051e6f671689eb73abdfa56b89d9 Mon Sep 17 00:00:00 2001 From: Rainnny7 Date: Wed, 11 Sep 2024 00:24:35 -0400 Subject: [PATCH] Update README.md --- README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 80 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c1a9996..dadff1f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,81 @@ -# Tether -An API designed to provide real-time access to a user's Discord data. + -## TODO -- [x] Caching -- [x] WebSockets -- [x] User account for extra data? (about me, connections, etc) \ No newline at end of file + +[![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) + + +
+
+ + Tether Logo + + +

Tether

+

+ 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) + + +## Features +- [ ] ... + +

(back to top)

+ + +## Roadmap +- [ ] ... + +

(back to top)

+ + +## 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: + + Top Tether Contributors + + +

(back to top)

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

(back to top)

\ No newline at end of file