Skip to content

Commit

Permalink
Added section about branches
Browse files Browse the repository at this point in the history
  • Loading branch information
bwmarrin committed Feb 20, 2016
1 parent e244177 commit 0b6a535
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,23 @@ for support.

## Getting Started

### master vs develop Branch
* The master branch represents the latest released version of Discordgo. This
branch will always have a stable and tested version of the library. Each release
is tagged and you can easily download a specific release and view release notes
on the github [releases](https://github.com/bwmarrin/discordgo/releases) page.

* The develop branch is where all development happens and almost always has
new features over the master branch. However breaking changes are frequently
added to develop and even sometimes bugs are introduced. Bugs get fixed and
the breaking changes get documented before pushing to master.

*So, what should you use?*

If you can accept the constant changing nature of *develop* then it is the
recommended branch to use. Otherwise, if you want to tail behind development
slightly and have a more stable package with documented releases then use *master*

### Installing

Discordgo has been tested to compile on Debian 8 (Go 1.3.3),
Expand All @@ -22,10 +39,21 @@ FreeBSD 10 (Go 1.5.1), and Windows 7 (Go 1.5.2).
This assumes you already have a working Go environment, if not please see
[this page](https://golang.org/doc/install) first.

`go get` *will always pull the latest released version from the master branch.*

```sh
$ go get github.com/bwmarrin/discordgo
go get github.com/bwmarrin/discordgo
```

If you want to use the develop branch, follow these steps next.

```sh
cd $GOPATH/src/github.com/bwmarrin/discordgo
git checkout develop
```



### Usage

Import the package into your project.
Expand Down

0 comments on commit 0b6a535

Please sign in to comment.