aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatarLarge Libravatar memdmp <memdmpestrogenzone>2025-07-06 06:25:16 +0200
committerLibravatarLarge Libravatar memdmp <memdmpestrogenzone>2025-07-06 06:25:16 +0200
commitd96467f63367c73f5f750e1c72de7ba1f05ef3ff (patch)
treefb9da935f0e6c23b730b79b1a1fc0551b4bcbd79 /README.md
downloaduic-parse-d96467f63367c73f5f750e1c72de7ba1f05ef3ff.tar.gz
uic-parse-d96467f63367c73f5f750e1c72de7ba1f05ef3ff.tar.bz2
uic-parse-d96467f63367c73f5f750e1c72de7ba1f05ef3ff.tar.lz
uic-parse-d96467f63367c73f5f750e1c72de7ba1f05ef3ff.zip

feat: initial commit

Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8e5cfa1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# uic-parse
+
+A rather untested, sleep deprived UIC parsing project for the sake of no fucking clue why honestly.
+
+Allows encoding and decoding from strings, aswell as from/to JSON - in a lossless\* way. Attempts to do country discovery. Can validate or backfill check digits.
+
+\*for strings, assuming we can identify countries correctly
+
+
+In library mode, it attempts to be a bit resillient by default and "fix" what it can - but (excluding throwing away garbage characters) can be configured to turn that into more aggressive erroring with options.
+
+In CLI mode, it defaults to all of those checks being enabled, and (for now with a single option without fine-grained control) being disablable with `--validate=false`.