github.com/nesv/gothub@v0.0.0-20140406181320-f0c824044d5f/README.md (about) 1 # GotHub 2 3 ## What is it? 4 5 GotHub is a library for interfacing with GitHub, for the Go programming 6 language. 7 8 ## How do I pronounce the name? 9 10 You can pronounce it like "got hub", "goth hub" for those darker times, or 11 really, however the heck you feel like pronouncing it. 12 13 "go thub" is also acceptable. 14 15 ## Why are you working on this? 16 17 Well, simply because I wanted a client-side library with which to utilize 18 GitHub's APIs, in a similar fashion to the 19 [PyGithub](https://github.com/jacquev6/PyGithub) library for Python. 20 21 ## How do I get it? 22 23 A simple `go get github.com/nesv/gothub` should be sufficient. 24 25 ## I can haz docs plz? 26 27 Documentation is automatically generated, and can be found here: 28 [http://godoc.org/github.com/nesv/gothub](http://godoc.org/github.com/nesv/gothub) 29 30 kthxbai. 31 32 ## Can I use this within my company's proprietary software? 33 34 You betcha. Check out the LICENSE.md file — the code and documentation for this project is 35 kept under the MIT license. In other words, feel free to copy it, sell it, do whatever you want, 36 just make sure to include the provided LICENSE.md file if you incorporate it into your stuff (or 37 your company's stuff). 38 39 ## Look, I need to run some tests on this to verify it even works... 40 41 And you can! No Go project can really be "complete" without tests. 42 43 To run the tests, you need to set two environment variables: `GITHUB_USERNAME` and 44 `GITHUB_PASSWORD`. Here is how you can run the tests without having to save these trinkets of 45 information anywhere: 46 47 $ GITHUB_USERNAME=<login> GITHUB_PASSWORD=<password> go test -v 48 49 Afterwards, be sure to delete your shell's history file, so that your credentials aren't laying 50 around anywhere. 51 52 ## I wanna help 53 54 Help is always appreciated! 55 56 If you have a bug or a feature request, please create an issue here in GitHub. 57 58 All of the development tasks are planned out in [Trello](https://trello.com). If you would like 59 to keep track of what is being worked on, check out the 60 [GotHub Development](https://trello.com/board/gothub-development/513689261eb6779e35005e29) board. 61 The tasks in Trello are broken down much further than they are in GitHub. 62 63 Once a feature, or bug, is completed in Trello, we will update the GitHub issue accordingly. 64 65 ### …I actually wanna write code 66 67 Even better! Sign up for an account on Trello and assign yourself to a card so the work can be 68 appropriately coordinated, then fork the repository. After your code is done, tests have passed 69 and all that good stuff, submit a pull request and your code will be merged in.