Skip to content

Commit

Permalink
[+] v0.1.3.1
Browse files Browse the repository at this point in the history
[+] read me
  • Loading branch information
0xMaka authored Sep 28, 2024
2 parents 043c677 + 7c06092 commit 9d26fd7
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 3 deletions.
76 changes: 73 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,81 @@
<!--
@title : README.md
@author : Maka
@notice : follow the white rabbit go full kawala
<3 -->

# Kawala - Just a Kwl Data Companion (High in Kawality)

<img src="misc/assets/kawala-800.png" width=800 >
<!-- ![kwla](https://github.com/user-attachments/assets/817f0c04-989b-439d-8ab7-91f996b288c5) -->

<!-- good vibes to you -->
---

#### What can it be used for?
Kawala should be useful to anyone interested in analysing or crafting calldata. <br>
Ranging from support at a protocol looking for a quick summary, to an operator debugging custom streams for their bot. <br>
See examples for inspiration.
See tests and examples for inspiration.

---

<table class="fixed-align">
<tbody>
<tr>
<td>
| 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. |
| <img width=135/> | <img width=430/> |
| => 👨‍💻 =>🐇=>🐨 | 4920646F6E2774206576656E207365652074686520636F64652E |

</td>

<td valign="top", valign="right">

| [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) |
| => -------- |
| <img width=100/> |

</td>
</tr>
</tbody>
</table>

<table class="fixed-align">
<tbody>
<tr>
<th>
ʕ•ﻌ•ʔ
</th>
</tr>
<tr>
<td valign="top", valign="center">
```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);
```
</td>
</tr>

<tr>
<td>
<img width=800/>
</td>
</tr>
</table>

... _416C6C20492073656520697320626C6F6E64652C206272756E657474652C20616E6420726564686561642E0A0A_ ![image](misc/assets/glider.png)
<!-- say free <3 -->
Binary file added misc/assets/glider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9d26fd7

Please sign in to comment.