Jkl 161 add read me

[BiPhan4]

Please review for accuracy.

[TheMarstonConnell]

@BiPhan4 still need a review on this or did erin look over it?

[BiPhan4]

@TheMarstonConnell Erin gave me some feed back on it but never clicked approve. I can wait for him to approve--he's who will be relying on it the most.

[dahn510]

👍

[BiPhan4]

@karnthis Hey Erin - could you click approve on this if it looks good to you? Cheers

[karnthis]

PR still has mixed casing styles. I don't know the implications of this on Golang, but this would be highly problematic for Javascript.

[BiPhan4]

@karnthis Ah you've pointed out an inconsistency with protocol buffers and golang standard. The .proto definitions are camel case but the generated class files--.pb.go--class files are using pascal casing.

The CLI wraps the tx.pb.go class file to use functions that take camelCase arguments, but it does not wrap query.pb.go--PascalCasing. I mistakenly followed the CLI when writing this readMe.

I've changed the readMe to reflect the types as they are defined in their .proto files, the single source of truth across all language implementations. Your APIs compile directly from the .proto files so you're good to go.

@TheMarstonConnell I merged most recent 1.2.0 into this PR just now and pushed my edit to the readMe. Please merge this PR into 1.2.0 if it all checks out.

Thank you.

[karnthis]

Lines 140/141 are still using inconsistent casing with the rest of the document. Please either update or notate the exceptions to the rule.

|hashparent | String | MerklePath("s")

|hashchild | String | Hex[ hash("home") ]

[BiPhan4]

@karnthis Fixed it. Thanks for catching that.