Merge pull request #4 from ionite34/dev

ionite34 · Sep 17, 2022 · 03c1dd0 · 03c1dd0
2 parents 12fe0a5 + c453f16
commit 03c1dd0
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "base2048"
-version = "0.1.0"
+description = "Binary encoding with Base2048 in Rust."
+version = "0.1.1"
 edition = "2021"
 exclude = ["/dist"]
 

diff --git a/README.md b/README.md
@@ -68,6 +68,23 @@ unpacked[2000:2002]
 >> '🦀🐍'
 ```
 
+### Decode errors are provided with a character-position of failure
+
+```python
+----> base2048.decode('༗ǥԢΝĒϧǰ༎ǥ')
+
+DecodeError: Unexpected character 8: ['ǥ'] after termination sequence 7: ['༎']
+```
+- To catch the error, use either `base2048.DecodeError` or its base exception, `ValueError`.
+```python
+from base2048 import DecodeError
+
+try:
+    base2048.decode('🤔')
+except DecodeError as e:
+    print(e)
+```
+
 ## License
 The code in this project is released under the [MIT License](LICENSE).
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "base2048"
-version = "0.1.0"
+version = "0.1.1"
 readme = "README.md"
 requires-python = ">=3.7"
 license = { text = "MIT" }