diff --git a/README.md b/README.md index c47837a0..eee330a9 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,66 @@ -# DTel V4 - +# DTel + -**V4 is a reworking of V3 in Typescript with better code and more features. You can't currently add it to your server but stay tuned!** +![version-master] ![version-development] -DTel is a Discord bot that allows you to set up a custom number and call other servers. +[![website-shield]][website] [![gitlocalize-shield]][gitlocalize] [![codacy-shield]][codacy] -The bot acts like a telephone network, but **cannot** make real-world calls. Sorry about that. - -You can >dial `*611` if you have any problems or questions about the bot, or if you get any troll/spam calls. +## What is DTel? +DTel is a Discord bot that allows you to communicate with other servers on Discord. +The bot acts like a telephone network, but **cannot** make real-world calls. (sorry about that) So, ready to dive into the world of DTel? -- Read **DTel's documentation** by clicking this button! [![Documentation Status](https://readthedocs.org/projects/dtel/badge/?version=latest)](http://dtel.austinhuang.me/en/latest) +- Read our [documentation][website]! + +- Want the bot for yourself? **Invite it** by clicking here! [![invite-bot-shield]][invite-bot] + +- Join the **DTel Headquarters server** to win credits, chat, get support and call other numbers at ease by clicking here! [![discord][invite-support-shield]][invite-support] + +## Contributing +There are a lot of ways to contribute to our bot, not just through code. +The main way, and probably easiest, is by [inviting][invite] the bot to your server(s) and using it. Though, there are many other ways: + +### Development +You can contribute to the development of DTel in multiple ways: + +- Contributing on GitHub +First read our [contributing guidelines][contributing]. Then you are ready to make issues with feature requests or bug reports. Or even resolve issues by forking this repository and making Pull Requests. + +- Testing new features +Join our testing server to play around with the newest features soon to come! [![Discord][invite-test-shield]][invite-test]. + +- Writing translations +Are you fluent in both English and another language? Then you can help us make the bot accessible to more people! You can start translating the bot on [GitLocalize]. + +### Financially +All of us at DTel have a passion for programming, which is why we were able to create and maintain DTel over the years. +However, hosting the bot isn't free. So if you like what we're doing, have a look at our VIP options by clicking here: [![vip-shield]][website-vip] + + + + +[invite-bot]: https://discordapp.com/oauth2/authorize?client_id=377609965554237453&scope=bot&permissions=125953 +[invite-test]: https://discord.gg/uWQfxdXtFY +[invite-support]: https://discord.gg/RN7pxrB +[server]: https://discord.gg/DcayXMc +[website]: https://dtel.austinhuang.me/ +[website-vip]: https://dtel.austinhuang.me/en/latest/VIP-Numbers/ +[gitlocalize]: https://gitlocalize.com/repo/3993 +[codacy]: https://www.codacy.com/gh/DTel-HQ/dtel/dashboard + + + +[contributing]: ./.github/CONTRIBUTING.md -- Want the bot for yourself? **Invite it** by clicking here! [![Get the bot](https://img.shields.io/badge/Discord-Get_The_Bot-7289DA.svg)](https://discordapp.com/oauth2/authorize?client_id=377609965554237453&scope=bot) + +[invite-bot-shield]: https://img.shields.io/badge/Discord-Get_The_Bot-7289DA.svg +[invite-support-shield]: https://img.shields.io/badge/Discord-Support_Server-7289DA.svg +[invite-test-shield]: https://img.shields.io/badge/Discord-Test_Server-7289DA.svg +[website-shield]: https://readthedocs.org/projects/dtel/badge/?version=latest +[gitlocalize-shield]: https://gitlocalize.com/repo/3993/whole_project/badge.svg +[codacy-shield]: https://app.codacy.com/project/badge/Grade/04d77bc4c8a44d869bfef5967030e249 +[vip-shield]: https://img.shields.io/badge/support_us-VIP-green -- Join the **DTel Headquarters server** to win credits, chat, get support and call other numbers at ease by clicking here! [![discord](https://img.shields.io/badge/Discord-Support_Server-7289DA.svg)](https://discord.gg/RN7pxrB) +[version-master]: https://img.shields.io/github/package-json/v/DTel-HQ/dtel/master +[version-development]: https://img.shields.io/github/package-json/v/DTel-HQ/dtel/development \ No newline at end of file