summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author zaaarf <zaaarf@proton.me>2023-08-26 22:12:26 +0200
committer zaaarf <zaaarf@proton.me>2023-08-26 22:12:26 +0200
commit12b48a4aa5a7cbb4e5e19809a2cfa2450c2812f8 (patch)
tree01a0cabc84618a3818a7ee5a8ff44bbab52e15f5
parentf4a6992f17e699b93dbd8696e7a19041a781d883 (diff)
chore: basic readme
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8bb527e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Lillero-mapper
+A tiny library to process mappings in various formats.
+
+## Why?
+I initially [meant to fork Enigma](https://github.com/zaaarf/enigma), but honestly it was far more than I needed, even when stripped down to its core library.
+
+The purpose of this library is to act as base for the [Lillero processor](https://github.com/zaaarf/lillero-processor/), to work with various mapping formats.
+
+## Usage
+Simply call `MapperProvider.getMapper()` and pass it a `List` of `String`s representing the mapping file's contents, line by line. Call then `populate()` on the resulting `IMapper`, passing the same `List` once again, and you'll have an object that can process stuff back and forth - granted that a mapper capable of parsing the input was found.