ralexstokes / ssz-rs

Implementation of ethereum's `ssz`
Apache License 2.0
102 stars 40 forks source link

docs: add examples and crate docs #49

Closed onbjerg closed 1 year ago

onbjerg commented 1 year ago

Adds some missing docs and some examples in the top-level module documentation. I am not entirely sure on what an "instance" is, so I did not explain much in the docs for that - is it a value?

ralexstokes commented 1 year ago

"instance" is, so I did not explain much in the docs for that - is it a value?

yeah, "instance" is just an instance of the type, aka a value -- if you want to change the name feel free