pothtonswer/discordmuffin
1
0
Fork 1
Code Issues 2 Pull requests 1 Projects 2 Releases Packages Wiki Activity Actions

Updated readme.

Browse source
This commit is contained in:
Bruce Marriner 2015-11-12 15:10:18 -06:00
parent f4445fb782
commit 666adbe0b4
1 changed files with 18 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,16 +1,27 @@
# Discordgo
Golang Discord API.
This is my first Golang project and it is ~~probably~~ ~~not~~ maybe even suitable for use :)
Discord API for Golang
Everything here so far is likely to change as I learn Golang better and refine the API names and such.
This is my first Golang project and it is ~~probably~~ ~~not~~ ~~maybe even~~
barely suitable for use :)
Initially my goal was to write a chatbot and I started working with https://github.com/Xackery/discord as my API. But that code doesn't work 100% and so I started slowly making changes to it. Anyhow, credit goes to https://github.com/Xackery/discord for getting me started.
Everything here so far is likely to change as I learn Golang better and refine
the API names and such. Because of that I do not yet recommend this for use
with anything super important :)
If you're looking for a functional Discord API for Golang check out https://github.com/gdraynz/go-discord which I recently found. It's much more complete and will likely help me learn how to improve what I have here.
Initially my goal was to write a chatbot and I started working with
https://github.com/Xackery/discord as my API. But that code didn't work 100%
at the time. So I started slowly making changes to it and eventually ended up
with something entirely different. Anyhow, credit goes to
https://github.com/Xackery/discord for getting me started.
If you're looking for a more functional Discord API for Golang check out
https://github.com/gdraynz/go-discord which I recently found. It's much more
complete and will likely help me learn how to improve what I have here.
# What Works
Right now I'm focusing on the REST API and have not done any Websockets work. You can do the following things using the client.go functions.
Low level functions exist for the core REST API and Websocket API.
* Login to Discord
* Get User information for a given user.
@ -20,13 +31,9 @@ Right now I'm focusing on the REST API and have not done any Websockets work. Y
* Get Channels for a given Server
* Get Messages for a given Channel
* Send Messages to a given Channel
* Start a Websocket connection and listen for and handle events.
* Logout from Discord.
All the code in the other files such as discord.go, session.go, etc are a playground where I'm working to provide another and easier way to access the API.
You can look at the demo.go example file to see all of the client.go functions in use.
# Other Discord APIs
- [go-discord](https://github.com/gdraynz/go-discord)
@ -38,4 +45,3 @@ You can look at the demo.go example file to see all of the client.go functions i
- [DiscordSharp](https://github.com/Luigifan/DiscordSharp)
- [Discord4J](https://github.com/knobody/Discord4J)
- [discordrb](https://github.com/meew0/discordrb)