Skip to content

Commit

Permalink
Add install to quickstart (#370)
Browse files Browse the repository at this point in the history
This seems like a fairly important thing to have in the quickstart.
  • Loading branch information
klauspost authored Oct 3, 2024
1 parent 128abdb commit 9279415
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 9279415

Please sign in to comment.