diff --git a/README.md b/README.md new file mode 100644 index 0000000..2da585b --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Gossip Registry + +Gossip is a registry plugin for go-micro which uses hashicorp/memberlist to broadcast registry information +via the SWIM protocol. + +## Usage + +Import the plugin as per usual + +```go +import _ "github.com/micro/go-plugins/registry/gossip" +``` + +On startup you'll see something like + +```go +2016/06/19 14:05:43 Local memberlist node 127.0.0.1:45465 +``` + +To join this gossip ring use `--registry_address 127.0.0.1:45465` when starting other nodes