bowbahdoe/json

Write usage documentation for reading/writing, encoding/decoding, streaming/generating

bowbahdoe opened this issue · 2 comments

There are a few usage modes and terms which should be explained.

  1. reading/writing

Taking JSON from a source and writing JSON back into a source.

  1. encoding/decoding

Taking a custom structure and turning it to JSON and taking JSON and converting it to a custom structure w/ assertions of the shape of said JSON.

  1. streaming/generating

Reading JSON one "event" at a time and writing json one "event" at a time

As well as a simple usage of each of those apis

I think #35 was a good start, but these needs more elaboration to reach the target audience

I think I will close this. Streaming/generating isn't that important atm and I was able to give I think a good enough tutorial and example usage for reading/writing + encoding/decoding