Skip to content

Commit

Permalink
update README.md : fix incorrect Description of Enums type (#74)
Browse files Browse the repository at this point in the history
  • Loading branch information
cbot918 authored Nov 21, 2023
1 parent 93a633d commit b6a6838
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ More complex objects are described by a JSON object. The following types are sup
- `{ option: Schema }` - an optional object. The type of the object is described by the `type` field.
- `{ map: { key: Schema, value: Schema }}` - a map. The type of the keys and values are described by the `key` and `value` fields respectively.
- `{ set: Schema }` - a set. The type of the elements is described by the `type` field.
- `{ enum: [{ className1: { struct: {...} } }, { className2: { struct: {...} } }, ... ] }` - an enum. The variants of the enum are described by the `className1`, `className2`, etc. fields. The variants are structs.
- `{ enum: [{ struct: {...} }, { struct: {...} }, ... ] }` - an enum. The variants of the enum are described by the `className1`, `className2`, etc. fields. The variants are structs.
- `{ struct: { field1: Schema1, field2: Schema2, ... } }` - a struct. The fields of the struct are described by the `field1`, `field2`, etc. fields.

### Type Mappings
Expand Down Expand Up @@ -119,4 +119,4 @@ When publishing to npm use [np](https://github.com/sindresorhus/np).
This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See [LICENSE-MIT](LICENSE-MIT.txt) and [LICENSE-APACHE](LICENSE-APACHE) for details.

[Borsh]: https://borsh.io
[Borsh]: https://borsh.io

0 comments on commit b6a6838

Please sign in to comment.