Skip to content

Commit

Permalink
Adjusted readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Frostie314159 committed Jan 5, 2024
1 parent 6b987e0 commit d5d5a63
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ For further information see this [stackoverflow post](https://stackoverflow.com/
* [x] Service response
## Features
The parser was designed to be able to run in low flash environments(i.e. ESP32, wasm).
To reduce size there is currently the option to disable the "read" or "write" feature, which will strip this functionality from the library. Other than that, there is the option to remove certain TLV parsers from the library, by turning of their respective features.
The listed time complexity refers to, if the parser runtime rises with input length. So O(1) means go ahead and O(n) means think before you parse. O(1) parsers are not benchmarked.
TLV | feature | Worst case time complexity
-- | -- | --
Expand All @@ -41,7 +40,8 @@ Version | version_tlv | O(1)

Do note please, that although the parsers are not yet present, the features are. Also some parsers were bundled into one feature. (For more information on this refer to Milan Stute's [dissertation](https://tuprints.ulb.tu-darmstadt.de/11457/1/dissertation_milan-stute_2020.pdf#table.caption.42).)
## no_std
The library is built with the `alloc` crate, which makes using it in a no_std environment with an allocator possible.
The library doesn't require any allocations, due to the author sacrificing parts of his sanity, to use Iterators everywhere.
Allocations are only used for testing, to verify that the reported sizes match reality.
## Credits
Although the actual parser was written by me, the reverse engineering of the AWDL protocol was conducted by Milan Stute and SeeMoo-Lab. So kudos to them...
- https://tuprints.ulb.tu-darmstadt.de/11457/1/dissertation_milan-stute_2020.pdf
Expand Down

0 comments on commit d5d5a63

Please sign in to comment.