diff --git a/README.md b/README.md index b4546e02..b2d91649 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ This is a code generation tool and serialization library for [MessagePack](http: ### Quickstart +First install the `msgp` generator command. Using Go this is done with `go install github.com/tinylib/msgp@latest` + In a source file, include the following directive: ```go @@ -51,6 +53,9 @@ While `msgp.Marshaler` and `msgp.Unmarshaler` are quite similar to the standard stream serialization. (`*msgp.Writer` and `*msgp.Reader` are essentially protocol-aware versions of `*bufio.Writer` and `*bufio.Reader`, respectively.) +An important thing to note is that msgp operates on *individual files*. +This means if your structs include types defined in other files, these must be processed as well. + ### Features - Extremely fast generated code