Skip to content

Commit

Permalink
Explain the readme a bit more
Browse files Browse the repository at this point in the history
  • Loading branch information
pearkes committed Jun 9, 2013
1 parent af9634b commit c642255
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ if necessary.

## Basic Example

Make a step to perform some action. The step can access your "state",
which is passed between steps by the runner.

```go
type stepAdd struct{}

Expand All @@ -24,7 +27,7 @@ func (s *stepAdd) Run(state map[string]interface{}) multistep.StepAction {
func (s *stepAdd) Cleanup(map[string]interface{}) {}
```

Call your step from a runner.
Make a runner and call your array of Steps.

```go
func main() {
Expand Down

0 comments on commit c642255

Please sign in to comment.