Skip to content

Commit 1186a53

Browse files
committed
license, readme
1 parent 41ccdaf commit 1186a53

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 @orsinium
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# postcard
2+
3+
A Go parser for [Postcard](https://github.com/jamesmunns/postcard) binary [wire format](https://postcard.jamesmunns.com/wire-format).
4+
5+
Follows the same design principles as [jsony](https://github.com/orsinium-labs/jsony), which allows for fast, type-safe, and reflection-free deserialization.
6+
7+
## Installation
8+
9+
```bash
10+
go get github.com/orsinium-labs/postcard
11+
```
12+
13+
## Usage
14+
15+
```go
16+
type User struct {
17+
name string
18+
age uint16
19+
}
20+
21+
var user User
22+
parse := postcard.Struct(
23+
postcard.Str(&user.name),
24+
postcard.U16(&user.age),
25+
)
26+
27+
reader := bytes.NewReader([]byte("\x07Aragorn\x52"))
28+
err := parse(reader)
29+
30+
fmt.Println(err) // nil
31+
fmt.Println(user.name) // "Aragorn"
32+
fmt.Println(user.age) // 82
33+
```

0 commit comments

Comments
 (0)