diff --git a/README.md b/README.md index 735ef79..87608ff 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,53 @@ Slack API in Go + +## Installing + +### *go get* + + $ go get github.com/nlopes/slack + +## Example + +### Getting all groups + + import ( + "fmt" + + "github.com/nlopes/slack" + ) + + func main() { + api := slack.New("YOUR_TOKEN_HERE") + // If you set debugging, it will log all requests to the console + // Useful when encountering issues + // api.SetDebug(true) + groups, err := api.GetGroups(false) + if err != nil { + fmt.Printf("%s\n", err) + return + } + for _, group := range groups { + fmt.Printf("Id: %s, Name: %s\n", group.Id, group.Name) + } + } + +### Getting User Information + + import ( + "fmt" + + "github.com/nlopes/slack" + ) + + func main() { + api := slack.New("YOUR_TOKEN_HERE") + user, err := api.GetUserInfo("U023BECGF") + if err != nil { + fmt.Printf("%s\n", err) + return + } + fmt.Printf("Id: %s, Fullname: %s, Email: %s\n", user.Id, user.Profile.RealName, user.Profile.Email) + } ## Why? I am currently learning Go and this seemed like a good idea. diff --git a/examples/groups/groups.go b/examples/groups/groups.go new file mode 100644 index 0000000..a4c6180 --- /dev/null +++ b/examples/groups/groups.go @@ -0,0 +1,22 @@ +package main + +import ( + "fmt" + + "github.com/nlopes/slack" +) + +func main() { + api := slack.New("YOUR_TOKEN_HERE") + // If you set debugging, it will log all requests to the console + // Useful when encountering issues + // api.SetDebug(true) + groups, err := api.GetGroups(false) + if err != nil { + fmt.Printf("%s\n", err) + return + } + for _, group := range groups { + fmt.Printf("Id: %s, Name: %s\n", group.Id, group.Name) + } +} diff --git a/examples/users/users.go b/examples/users/users.go new file mode 100644 index 0000000..6d967b5 --- /dev/null +++ b/examples/users/users.go @@ -0,0 +1,17 @@ +package main + +import ( + "fmt" + + "github.com/nlopes/slack" +) + +func main() { + api := slack.New("YOUR_TOKEN_HERE") + user, err := api.GetUserInfo("U023BECGF") + if err != nil { + fmt.Printf("%s\n", err) + return + } + fmt.Printf("Id: %s, Fullname: %s, Email: %s\n", user.Id, user.Profile.RealName, user.Profile.Email) +}