Skip to content

Commit

Permalink
update readme (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
fardream authored Dec 27, 2022
1 parent 1354b2b commit b49f70c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Binary Canonical Serialization (bcs) for Golang.
[![Go Reference](https://pkg.go.dev/badge/github.com/fardream/go-bcs.svg)](https://pkg.go.dev/github.com/fardream/go-bcs)

Binary Canonical Serialization (bcs) or Libra Canonical Serialization (lcs) is developed
for the shuttlered [libra/diem](https://www.diem.com/) blockchain project.
for the shuttered [libra/diem](https://www.diem.com/) blockchain project.

Its target is mainly rust-lang struct, although many [move-lang](https://github.com/move-language/move) based
BCS target is mainly rust-lang struct, although many [move-lang](https://github.com/move-language/move) based
blockchains use it as serialization format.

Given its root in rust, bcs include many structs are unavailable in golang (or move-lang), such as enum, option. See [go package website](https://pkg.go.dev/github.com/fardream/go-bcs) for more details.
Given its root in rust, bcs include many features unavailable in golang (or move-lang), such as enum, option. See [go package website](https://pkg.go.dev/github.com/fardream/go-bcs) for more details.
4 changes: 1 addition & 3 deletions bcs/tag.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ import (
"strings"
)

const (
tagName = "bcs"
)
const tagName = "bcs"

const (
tagValue_Optional int64 = 1 << iota // optional
Expand Down
2 changes: 1 addition & 1 deletion bcs/unmarshaler.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import "io"
// Unmarshaler customizes the unmarshalling behavior for a type.
//
// Compared with other Unmarshalers in golang, the Unmarshaler here takes
// a [io.Reader] instead of []byte, since it is difficult to delimit the byte streams.
// a [io.Reader] instead of []byte, since it is difficult to delimit the byte streams without unmarshalling.
type Unmarshaler interface {
UnmarshalBCS(io.Reader) (int, error)
}

0 comments on commit b49f70c

Please sign in to comment.