docs: improve wording & organize sections (#439)

* docs: improve wording

* idk

* idk

* idk

* idk

* i love discord.js

* duplicate argh

* edsoifghdsopsigv
This commit is contained in:
Ayyan
2021-01-24 18:48:16 +04:00
committed by GitHub
parent 51387c5705
commit 3f407c901b
4 changed files with 52 additions and 68 deletions
+27 -29
View File
@@ -1,11 +1,13 @@
# Discordeno
> Discord API library for Deno
> Discord API library for [Deno](https://deno.land)
[![Discord](https://img.shields.io/discord/785384884197392384?color=7289da&logo=discord&logoColor=dark)](https://discord.com/invite/5vBgXk3UcZ)
![Lint](https://github.com/discordeno/discordeno/workflows/Lint/badge.svg)
![Test](https://github.com/discordeno/discordeno/workflows/Test/badge.svg)
## 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
@@ -14,34 +16,20 @@
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 and easy-to-use. Always
prefer defaults that Discord recommends or the best configuration for the
majority―if necessary, it is remarkably customizable, versatile, and
efficient.
- **Functional API**: This will produce a cleaner and more performant code while
removing the difficulties of extending built-in classes and inheritance. Avoid
potential memory leaks or crashes because of too many listeners or other silly
issues.
- **Efficient & lightweight**: Discordeno is simplistic, easy-to-use, versatile,
and efficient. Uses
[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.
- [**Functional API**](https://en.wikipedia.org/wiki/Functional_programming):
This will produce an overall concise and more performant code while removing
the difficulties of extending built-in classes and inheritance.
## Usage
## Getting Started
### Beginner Developers
### Minimal Example
Don't worry a lot of developers start out coding their first projects as a
Discord bot (I did 😉) and it is not so easy to do so. Discordeno is built
considering all the issues with pre-existing libraries and issues that I had
when I first started out coding bots. If you are a beginner developer, you may
check out these awesome official and unofficial boilerplates:
- Official Discordeno Boilerplate
- [GitHub](https://github.com/Skillz4Killz/Discordeno-bot-template)
- [Features](https://github.com/Skillz4Killz/Discordeno-bot-template#features)
If you do not wish to use a boilerplate, you may continue reading.
### Advanced Developers
Here's a minimal example to get started with:
Here is a minimal example to get started with:
```typescript
import { startBot } from "https://deno.land/x/discordeno/mod.ts";
@@ -62,6 +50,18 @@ startBot({
});
```
### Boilerplates
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 Bot Template (official)](https://github.com/Skillz4Killz/Discordeno-bot-template)
- [Add Your Own!](https://github.com/discordeno/discordeno/pulls)
## Useful Links
- [Website](https://discordeno.mod.land)
@@ -70,9 +70,7 @@ startBot({
## Contributing
We appreciate your help!
Before contributing, please read the
We appreciate your help! Before contributing, please read the
[Contributing Guide](https://github.com/discordeno/discordeno/blob/master/.github/CONTRIBUTING.md).
### License