feat: Labs deprecation & readme expansion (#2406)

This commit is contained in:
Armano den Boef
2022-08-01 21:47:53 +02:00
committed by GitHub
parent 519deda6e7
commit bf493ea040
8 changed files with 85 additions and 84 deletions

View File

@@ -8,18 +8,22 @@ title: Terminology
## Preface
Most terms for objects remain the same between 0.9 and 1.0 and above.
The major difference is that the ``Server`` is now called ``Guild``
The major difference is that the `Server` is now called `Guild`
to stay in line with Discord internally.
## Implementation Specific Entities
Discord.Net is split into a core library and two different
implementations - `Discord.Net.Core`, `Discord.Net.Rest`, and
`Discord.Net.WebSockets`.
`Discord.Net.WebSocket`.
As a bot developer, you will only need to use `Discord.Net.WebSockets`,
You will typically only need to use `Discord.Net.WebSocket`,
but you should be aware of the differences between them.
> [!TIP]
> If you are looking to implement Rest based interactions, or handle calls over REST in any other way,
> `Discord.Net.Rest` is the resource most applicable to you.
`Discord.Net.Core` provides a set of interfaces that models Discord's
API. These interfaces are consistent throughout all implementations of
Discord.Net, and if you are writing an implementation-agnostic library
@@ -33,4 +37,4 @@ implementation are prefixed with `Rest` (e.g., `RestChannel`).
`Discord.Net.WebSocket` provides a set of concrete classes that are
used primarily with Discord's WebSocket API or entities that are kept
in cache. When developing bots, you will be using this implementation.
All entities are prefixed with `Socket` (e.g., `SocketChannel`).
All entities are prefixed with `Socket` (e.g., `SocketChannel`).