doc

radumarias · Jun 2, 2024 · 5f82744 · 5f82744
1 parent 680ae2b
commit 5f82744
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 5 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zeroize"
-version = "0.1.3"
+version = "0.1.4"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/README.md b/README.md
@@ -19,12 +19,15 @@ arr = bytearray(b'1234567890')
 arr_np = np.array([0] * 10, dtype=np.uint8)
 arr_np[:] = arr
 assert arr_np.tobytes() == b'1234567890'
+
+print("zeroize'ing...: ")
 zeroize.zeroize1(arr)
 zeroize.zeroize_np(arr_np)
-print("zeroize'ing...: ")
+
 print("checking if is zeroized...")
 assert arr == bytearray(b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
 assert all(arr_np == 0)
+
 print("all good, bye!")
 ```
 # Building from source

diff --git a/main.py b/main.py
@@ -2,14 +2,20 @@
 import numpy as np
 
 
+# regular array
 arr = bytearray(b'1234567890')
+
+# numpy array
 arr_np = np.array([0] * 10, dtype=np.uint8)
 arr_np[:] = arr
 assert arr_np.tobytes() == b'1234567890'
+
+print("zeroize'ing...: ")
 zeroize.zeroize1(arr)
 zeroize.zeroize_np(arr_np)
-print("zeroize'ing...: ")
+
 print("checking if is zeroized...")
 assert arr == bytearray(b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
 assert all(arr_np == 0)
-print("all good, bye!")
+
+print("all good, bye!")