This PR adds crate level documentation. You can test & read it via:
cargo doc -p balena-temen --open
All examples should show demonstrate how to use this crate. This is not user level (person who is going to write DSL expressions) documentation (expression grammar, etc.).
It also contains small tweaks and preparations for API stabilisation. Mostly shuffling things around. So, it partially fixes:
3 - partially because README.md isn't updated yet
10 - partially because it's still not optimised (#4, ...)
This PR adds crate level documentation. You can test & read it via:
cargo doc -p balena-temen --openAll examples should show demonstrate how to use this crate. This is not user level (person who is going to write DSL expressions) documentation (expression grammar, etc.).
It also contains small tweaks and preparations for API stabilisation. Mostly shuffling things around. So, it partially fixes:
3 - partially because README.md isn't updated yet
10 - partially because it's still not optimised (#4, ...)