diff --git a/README.md b/README.md index d37b49e..fd1e9b8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,81 @@ + + # Kawala - Just a Kwl Data Companion (High in Kawality) - - + + --- #### What can it be used for? Kawala should be useful to anyone interested in analysing or crafting calldata.
Ranging from support at a protocol looking for a quick summary, to an operator debugging custom streams for their bot.
-See examples for inspiration. +See tests and examples for inspiration. + +--- + + + + + + + + + +
+ +| codebase | description | +|------------------------------|-------------------------------------------------------| +| => [lib.rs](src/lib.rs) | Core lib, base types, Kawala specific functionality. | +| => [kwl32.rs](src/kwl32.rs) | Foundational mod, handles the 32 byte word operations.| +| => [bai.rs](src/bai.rs) | Foundational mod, handles the hex / byte conversions. | +| => [examples](examples/) | Examples, focused on realistic scenarios. | +| => [tests](tests/) | Kawala test suite. | +| | | +| => 👨‍💻 =>🐇=>🐨 | 4920646F6E2774206576656E207365652074686520636F64652E | + + + +| [version history](misc/kawalas_log.md) | +|-------------------------------------------| +| => [v0.1.3](misc/kawalas_log.md#v013) | +| => [v0.1.2](misc/kawalas_log.md#v012) | +| => [v0.1.1](misc/kawalas_log.md#v011) | +| => -------- | +| | + +
+ + + + + + + + + + + + + +
+ ʕ•ﻌ•ʔ +
+ +```rust +/* install *///---------------//* import *///-------------------------> +/* Run in dir: */ use kawala::{ View, Calldata, WithSig }; +cargo add kawala // +// or add to Cargo.toml: //* init *///-------------------------------------------------------> +kawala = "0.1.2" let mut view = View::new(Calldata::from_hex("ff"), WithSig::False); +``` +
+ +
+ +... _416C6C20492073656520697320626C6F6E64652C206272756E657474652C20616E6420726564686561642E0A0A_ ![image](misc/assets/glider.png) + diff --git a/misc/assets/glider.png b/misc/assets/glider.png new file mode 100644 index 0000000..15559aa Binary files /dev/null and b/misc/assets/glider.png differ