qntfy / kazaam

Arbitrary transformations of JSON in Golang
MIT License
283 stars 54 forks source link

Cannot find detailed documentation #118

Open MikeTaylor opened 1 year ago

MikeTaylor commented 1 year ago

I don't know if I'm being an idiot, but if I am then I think the present documentation is to blame. I can't find any documentation of Kazaam that expains in any detail how to use the operations. For example, the overview of the operations as documented at https://pkg.go.dev/gopkg.in/qntfy/kazaam.v3 doesn't even mention the over part of a specification — I only stumbled across it by reading issues in this tracker!

Is there documentation somewhere that I missed? If so, could we please have a prominent link to it in the top-level doc?