Skip to content

Commit

Permalink
Update document.
Browse files Browse the repository at this point in the history
  • Loading branch information
ngdinhtoan committed Jul 2, 2015
1 parent 1490919 commit b1ca363
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 3 additions & 3 deletions jira/doc.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// Package jira implement slackcmd.Commander to handle request about jira ticket,
// it will get ticket IDs from request, and give back ticket details into the channel that sent command.
//
// This package (slackcmd also) use Viper (https://github.com/spf13/viper) for manage configuration of app,
// so, copy config from file `config.yml.dist` to your application config, replace by your config value,
// This package (and package slackcmd also) use Viper (https://github.com/spf13/viper) to manage configuration of app.
// So, copy config from file `config.yml.dist` to your application config, replace by your config value,
// and use Viper to load the config.
//
// Check out example package in (github.com/ngdinhtoan/slackcmd/example) to see how to use this package.
// Check out package example (github.com/ngdinhtoan/slackcmd/example) to see how to use this package.
package jira
2 changes: 2 additions & 0 deletions payload.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,10 @@ type PayloadValidator interface {

// NewTokenValidator return an implement of PayloadValidator,
// TokenValidator will check if token sent by Slack Commands are match with token that in configuration.
//
// Token in configuration will be load by Viper (github.com/spf13/viper) at key `slackcmd.tokens`,
// that key should be a map of comand and token, check `config.yml.dist` in package example.
//
// If token was not configured, then the payload is always valid with any token.
func NewTokenValidator() PayloadValidator {
return &tokenValidator{}
Expand Down

0 comments on commit b1ca363

Please sign in to comment.