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

Misc changes to docs (#907)

Browse source 
* Misc changes

* Update index.md

Fix GettingStarted link + misc changes

* Update index.md

Fix DiscordGo image

* Update README.md

Fix image

* Fix image
This commit is contained in:
person-with-a-username 2021-05-14 22:19:57 -04:00 committed by GitHub
parent ec2cf69202
commit a7c15e1bab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -2,7 +2,7 @@
[![Go Reference](https://pkg.go.dev/badge/github.com/bwmarrin/discordgo.svg)](https://pkg.go.dev/github.com/bwmarrin/discordgo) [![Go report](http://goreportcard.com/badge/bwmarrin/discordgo)](http://goreportcard.com/report/bwmarrin/discordgo) [![Build Status](https://travis-ci.com/bwmarrin/discordgo.svg?branch=master)](https://travis-ci.com/bwmarrin/discordgo) [![Discord Gophers](https://img.shields.io/badge/Discord%20Gophers-%23discordgo-blue.svg)](https://discord.gg/0f1SbxBZjYoCtNPP) [![Discord API](https://img.shields.io/badge/Discord%20API-%23go_discordgo-blue.svg)](https://discord.com/invite/discord-api)
<img align="right" src="http://bwmarrin.github.io/discordgo/img/discordgo.png">
<img align="right" src="https://github.com/bwmarrin/discordgo/blob/master/docs/img/discordgo.png">
DiscordGo is a [Go](https://golang.org/) package that provides low level
bindings to the [Discord](https://discord.com/) chat client API. DiscordGo

16
docs/GettingStarted.md
View file

@ -14,7 +14,7 @@ A bot application is a special program that interacts with the Discord servers
to perform some form of automation or provide some type of service. Examples
are things like number trivia games, music streaming, channel moderation,
sending reminders, playing loud airhorn sounds, comic generators, YouTube
integration, Twitch integration.. You're *almost* only limited by your imagination.
integration, Twitch integration... You're *almost* only limited by your imagination.
Bot applications require the use of a special Bot account. These accounts are
tied to your personal user account. Bot accounts cannot login with the normal
@ -28,26 +28,26 @@ page and click on the **New Application** box. Follow the prompts from there
to finish creating your account.
**More information about Bots vs Client accounts can be found [here](https://discord.com/developers/docs/topics/oauth2#bot-vs-user-accounts)**
**More information about Bot vs Client accounts can be found [here](https://discord.com/developers/docs/topics/oauth2#bot-vs-user-accounts).**
# Requirements
DiscordGo requires Go version 1.4 or higher. It has been tested to compile and
run successfully on Debian Linux 8, FreeBSD 10, and Windows 7. It is expected
that it should work anywhere Go 1.4 or higher works. If you run into problems
please let us know :)
please let us know :).
You must already have a working Go environment setup to use DiscordGo. If you
are new to Go and have not yet installed and tested it on your computer then
please visit [this page](https://golang.org/doc/install) first then I highly
recommend you walk though [A Tour of Go](https://tour.golang.org/welcome/1) to
help get your familiar with the Go language. Also checkout the relevent Go plugin
for your editor - they are hugely helpful when developing Go code.
for your editor &mdash; they are hugely helpful when developing Go code.
* Vim - [vim-go](https://github.com/fatih/vim-go)
* Sublime - [GoSublime](https://github.com/DisposaBoy/GoSublime)
* Atom - [go-plus](https://atom.io/packages/go-plus)
* Visual Studio - [vscode-go](https://github.com/Microsoft/vscode-go)
* Vim &mdash; [vim-go](https://github.com/fatih/vim-go)
* Sublime &mdash; [GoSublime](https://github.com/DisposaBoy/GoSublime)
* Atom &mdash; [go-plus](https://atom.io/packages/go-plus)
* Visual Studio &mdash; [vscode-go](https://github.com/Microsoft/vscode-go)
# Install DiscordGo

10
docs/index.md
View file

@ -1,15 +1,15 @@
## DiscordGo
<hr>
<img align="right" src="http://bwmarrin.github.io/discordgo/img/discordgo.png">
<img align="right" src="https://github.com/bwmarrin/discordgo/blob/master/docs/img/discordgo.png">
[Go](https://golang.org/) (golang) interface for the [Discord](https://discord.com/)
[Go](https://golang.org/) (Golang) interface for the [Discord](https://discord.com/)
chat service. Provides both low-level direct bindings to the
Discord API and helper functions that allow you to make custom clients and chat
bot applications easily.
[Discord](https://discord.com/) is an all-in-one voice and text chat for
gamers that's free, secure, and works on both your desktop and phone.
### Why DiscordGo?
* High Performance
* Minimal Memory & CPU Load
@ -19,7 +19,7 @@ gamers that's free, secure, and works on both your desktop and phone.
* State tracking and caching
### Learn More
* Check out the [Getting Started](GettingStarted) section
* Check out the [Getting Started](GettingStarted.md) section
* Read the reference docs on [Godoc](https://godoc.org/github.com/bwmarrin/discordgo) or [GoWalker](https://gowalker.org/github.com/bwmarrin/discordgo)
* Try the [examples](https://github.com/bwmarrin/discordgo/tree/master/examples)
* Explore [Awesome DiscordGo](https://github.com/bwmarrin/discordgo/wiki/Awesome-DiscordGo)
@ -27,7 +27,7 @@ gamers that's free, secure, and works on both your desktop and phone.
### Join Us!
Both of the below links take you to chat channels where you can get more
information and support for DiscordGo. There's also a chance to make some
friends :)
friends :).
* Join the [Discord Gophers](https://discord.gg/0f1SbxBZjYoCtNPP) chat server dedicated to Go programming.
* Join the [Discord API](https://discord.com/invite/discord-API) chat server dedicated to the Discord API.

2
examples/README.md
View file

@ -1,4 +1,4 @@
<img align="right" src="http://bwmarrin.github.io/discordgo/img/discordgo.png">
<img align="right" src="https://github.com/bwmarrin/discordgo/blob/master/docs/img/discordgo.png">
# DiscordGo Examples