diff --git a/README.md b/README.md index 9b1464acd..75d7b7e4b 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,20 @@ ## Features -- **Secure & stable**: Discordeno is comparatively more stable than the other - libraries. One of the greatest issues with almost every library is stability; - types are outdated, less (or minimal) parity with the API, core maintainers - have quit or no longer actively maintain the library, and whatnot. Discordeno, - on the other hand, is actively maintained to ensure great performance and - convenience. Discordeno internally checks all missing permissions before - forwarding a request to the API so that the client does not get - globally-banned by Discord. -- **Efficient & lightweight**: Discordeno is simplistic, easy-to-use, versatile, - and efficient. Follows +- **Secure & stable**: Discordeno is secure and stable. One of the greatest + issues with almost every library is stability; types are outdated, less (or + minimal) parity with the API, core maintainers have quit or no longer actively + maintain the library, and whatnot. Discordeno, on the other hand, is actively + maintained to ensure great performance and convenience. Moreover, it + internally checks all missing permissions before forwarding a request to the + Discord API so that the client does not get globally-banned by Discord. +- **Simple, Efficient, & Lightweight**: Discordeno is simplistic, easy-to-use, + versatile while being efficient and lightweight. Follows [Convention Over Configuration](https://en.wikipedia.org/wiki/Convention_over_configuration) - design paradigm ― prefers defaults that Discord recommends or the best - configuration for the majority of the users. + design paradigm ― prefers defaults options or values that are recommended by + Discord or the best configuration for the majority of the users. - [**Functional API**](https://en.wikipedia.org/wiki/Functional_programming): - This will produce an overall concise and more performant code while removing + Functional API ensures an overall concise yet performant code while removing the difficulties of extending built-in classes and inheritance. ## Getting Started @@ -54,12 +53,14 @@ startBot({ Note to developers: don't worry a lot of developers start out programming a Discord bot as their first project (I did 😉) and it is not so easy to do so. -Discordeno is built considering all the issues that I and a lot of developers -that I personally know had when I first started out coding Discord bots with -existing libraries. If you are a beginner, you can check out these awesome -official and unofficial boilerplates: +Discordeno is designed and built considering all the issues that I and a lot of +developers had when I first started out coding Discord bots with existing +libraries. If you are a beginner, you can check out these awesome official and +unofficial boilerplates: -- [Discordeno Bot Template (official)](https://github.com/Skillz4Killz/Discordeno-bot-template) +- [Discordeno Bot Template (official)](https://github.com/discordeno/discordeno-bot-template) +- [Serverless Slash Commands Template + (official)](https://github.com/discordeno-slash-bot) - [Add Your Own!](https://github.com/discordeno/discordeno/pulls) ## Useful Links diff --git a/docs/src/README.md b/docs/src/README.md index 8d8683087..20afdd20f 100644 --- a/docs/src/README.md +++ b/docs/src/README.md @@ -8,22 +8,22 @@ ## Features -- **Secure & stable**: Discordeno is comparatively more stable than the other - libraries. One of the greatest issues with almost every library is stability; - types are outdated, less (or minimal) parity with the API, core maintainers - have quit or no longer actively maintain the library, and whatnot. Discordeno, - on the other hand, is actively maintained to ensure great performance and - convenience. Discordeno internally checks all missing permissions before - forwarding a request to the API so that the client does not get - globally-banned by Discord. -- **Efficient & lightweight**: Discordeno is simplistic, easy-to-use, versatile, - and efficient. Uses +- **Secure & stable**: Discordeno is secure and stable. One of the greatest + issues with almost every library is stability; types are outdated, less (or + minimal) parity with the API, core maintainers have quit or no longer actively + maintain the library, and whatnot. Discordeno, on the other hand, is actively + maintained to ensure great performance and convenience. Moreover, it + internally checks all missing permissions before forwarding a request to the + Discord API so that the client does not get globally-banned by Discord. +- **Simple, Efficient, & Lightweight**: Discordeno is simplistic, easy-to-use, + versatile while being efficient and lightweight. Follows [Convention Over Configuration](https://en.wikipedia.org/wiki/Convention_over_configuration) - design paradigm ― prefers defaults that Discord recommends or the best - configuration for the majority of the users. + design paradigm ― prefers defaults options or values that are recommended by + Discord or the best configuration for the majority of the users. - [**Functional API**](https://en.wikipedia.org/wiki/Functional_programming): - This will produce an overall concise and more performant code while removing + Functional API ensures an overall concise yet performant code while removing the difficulties of extending built-in classes and inheritance. + [Learn more about class-free JavaScript](https://dannyfritz.wordpress.com/2014/10/11/class-free-object-oriented-programming/) ## Useful Links diff --git a/docs/src/migrating.md b/docs/src/migrating.md index dd8c7455a..8ccbece2c 100644 --- a/docs/src/migrating.md +++ b/docs/src/migrating.md @@ -6,7 +6,7 @@ This migration guide is not intended to discredit Discord.js authors/maintainers or Discord.js itself. In fact, Discord.js is the most popular Node.js library, admired and praised by a lot of JavaScript developers. -## Finding A Open Source Bot +## Finding an Open-Source Discord Bot For the purposes of this guide, I wanted to find a moderation bot that is totally open source to show an example of how to convert the bot to Discordeno.