Add example usage to README.md

Author: fgrosse

README.md

@@ -15,22 +15,84 @@ This repository contains a module for the [Joe Bot library][joe].
 
 ## Getting Started
 
-Joe is packaged using the new [Go modules][go-modules]. Therefore the recommended
-installation is by adding joe and all used modules to your `go.mod` file like this: 
+This library is packaged using the new [Go modules][go-modules]. You can get it via:
 
 ```
-module github.com/go-joe/example-bot
-
-require (
-	github.com/go-joe/joe v0.4.0
-	github.com/go-joe/redis-memory v0.2.0
-	…
-)
+go get github.com/go-joe/redis-memory
 ```
 
 ### Example usage
 
-TODO
+In order to connect your bot to Redis you can simply pass it as module when
+creating a new bot:
+
+[embedmd]:# (_examples/main.go)
+```go
+package main
+
+import (
+	"github.com/go-joe/joe"
+	"github.com/go-joe/redis-memory"
+	"github.com/pkg/errors"
+)
+
+type ExampleBot struct {
+	*joe.Bot
+}
+
+func main() {
+	b := &ExampleBot{
+		Bot: joe.New("example",
+			redis.Memory("localhost:6379"),
+		),
+	}
+
+	b.Respond("remember (.+) is (.+)", b.Remember)
+	b.Respond("what is (.+)", b.WhatIs)
+	b.Respond("show keys", b.ShowKeys)
+
+	err := b.Run()
+	if err != nil {
+		b.Logger.Fatal(err.Error())
+	}
+}
+
+func (b *ExampleBot) Remember(msg joe.Message) error {
+	key, value := msg.Matches[0], msg.Matches[1]
+	msg.Respond("OK, I'll remember %s is %s", key, value)
+	return b.Store.Set(key, value)
+}
+
+func (b *ExampleBot) WhatIs(msg joe.Message) error {
+	key := msg.Matches[0]
+	var value string
+	ok, err := b.Store.Get(key, &value)
+	if err != nil {
+		return errors.Wrapf(err, "failed to retrieve key %q from brain", key)
+	}
+
+	if ok {
+		msg.Respond("%s is %s", key, value)
+	} else {
+		msg.Respond("I do not remember %q", key)
+	}
+
+	return nil
+}
+
+func (b *ExampleBot) ShowKeys(msg joe.Message) error {
+	keys, err := b.Store.Keys()
+	if err != nil {
+		return err
+	}
+
+	msg.Respond("I got %d keys:", len(keys))
+	for i, k := range keys {
+		msg.Respond("%d) %q", i+1, k)
+	}
+	return nil
+}
+```
 
 ## Built With
 
@@ -57,6 +119,10 @@ See also the list of [contributors][contributors] who participated in this proje
 
 This project is licensed under the BSD-3-Clause License - see the [LICENSE](LICENSE) file for details.
 
+## Acknowledgments
+
+- [embedmd][embedmd] for a cool tool to embed source code in markdown files
+
 [joe]: https://github.com/go-joe/joe
 [go-modules]: https://github.com/golang/go/wiki/Modules
 [tags]: https://github.com/go-joe/redis-memory/tags

_examples/main.go

@@ -0,0 +1,64 @@
+package main
+
+import (
+	"github.com/go-joe/joe"
+	"github.com/go-joe/redis-memory"
+	"github.com/pkg/errors"
+)
+
+type ExampleBot struct {
+	*joe.Bot
+}
+
+func main() {
+	b := &ExampleBot{
+		Bot: joe.New("example",
+			redis.Memory("localhost:6379"),
+		),
+	}
+
+	b.Respond("remember (.+) is (.+)", b.Remember)
+	b.Respond("what is (.+)", b.WhatIs)
+	b.Respond("show keys", b.ShowKeys)
+
+	err := b.Run()
+	if err != nil {
+		b.Logger.Fatal(err.Error())
+	}
+}
+
+func (b *ExampleBot) Remember(msg joe.Message) error {
+	key, value := msg.Matches[0], msg.Matches[1]
+	msg.Respond("OK, I'll remember %s is %s", key, value)
+	return b.Store.Set(key, value)
+}
+
+func (b *ExampleBot) WhatIs(msg joe.Message) error {
+	key := msg.Matches[0]
+	var value string
+	ok, err := b.Store.Get(key, &value)
+	if err != nil {
+		return errors.Wrapf(err, "failed to retrieve key %q from brain", key)
+	}
+
+	if ok {
+		msg.Respond("%s is %s", key, value)
+	} else {
+		msg.Respond("I do not remember %q", key)
+	}
+
+	return nil
+}
+
+func (b *ExampleBot) ShowKeys(msg joe.Message) error {
+	keys, err := b.Store.Keys()
+	if err != nil {
+		return err
+	}
+
+	msg.Respond("I got %d keys:", len(keys))
+	for i, k := range keys {
+		msg.Respond("%d) %q", i+1, k)
+	}
+	return nil
+}