diff --git a/README.md b/README.md index 765a92a3c..c4ad1e4d5 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,7 @@ # Discord.Net v0.7.1-beta1 An unofficial .Net API Wrapper for the Discord client (http://discordapp.com). -[Join the discussion](https://discord.gg/0SBTUU1wZTVjAMPx) on Discord. - -### This is an alpha! -The Discord API is still in active development, meaning this library may break at any time without notice. -Discord.Net itself is also in alpha so several functions may be unstable or not work at all. +Check out the [documentation](https://discordnet.readthedocs.org/en/latest/) or join the [Discord API Chat](https://discord.gg/0SBTUU1wZTVjAMPx). ### Current Features - Using Discord API version 3 @@ -15,42 +11,11 @@ Discord.Net itself is also in alpha so several functions may be unstable or not - Basic Voice Support (Outgoing only, Unencrypted only) - Command extension library (Supports permission levels) -### NuGet Packages +### Installation +You can download Discord.Net from NuGet: - [Discord.Net](https://www.nuget.org/packages/Discord.Net/) - [Discord.Net.Commands](https://www.nuget.org/packages/Discord.Net.Commands/) -### Example (Echo Client) -``` -var client = new DiscordClient(); -client.MessageCreated += async (s, e) => -{ - if (e.Message.UserId != client.User.Id) - await client.SendMessage(e.Message.ChannelId, e.Message.Text); -}; -await client.Connect("discordtest@email.com", "Password123"); -``` - -### Example (Command Client) -(Requires Discord.Net.Commands) -``` -var client = new DiscordBotClient(); -client.CreateCommand("acceptinvite") - .ArgsEqual(1) - .Do(async e => - { - try - { - await _client.AcceptInvite(e.Args[0]); - await _client.SendMessage(e.Channel, $"Invite \"{e.Args[0]}\" accepted."); - } - catch (HttpException ex) - { - await _client.SendMessage(e.Channel, $"Error: {ex.Message}"); - } - }); -await client.Connect("discordtest@email.com", "Password123"); -``` - ### Known Issues - Due to current Discord restrictions, private messages are blocked unless both the sender and recipient are members of the same server. - The Message caches does not currently clean up when their entries are no longer referenced, and there is currently no cap to it. For now, disconnecting and reconnecting will clear all caches.