Minor doc simplification, clarification, and cleanup.

farmOS / farmOS.js

A JavaScript library for working with farmOS data structures and interacting with farmOS servers.

MIT License

17 stars 13 forks source link

Closed mstenta closed 5 years ago

mstenta commented 5 years ago

The README.md docs look great! I made a few small changes for your consideration. What do you think?

mstenta commented 5 years ago

The whitespace commit just adds/removes newlines, indentation, and line breaks at column 80 for consistency with other docs.
I removed a bunch of the optional properties of log, asset, and area JSON. It might be good to document all of them somewhere, but I think we can keep it simple for these examples.
Lastly, clarified that log, asset, and area types depend on installed modules.

jgaehring commented 5 years ago

Thanks for taking the time to clean this up!