add docs in readme

mishankov · Mar 5, 2024 · bfc91bf · bfc91bf
1 parent 73554c6
commit bfc91bf
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,15 @@
 # String manipulator
+
+Application that applies sequence of manipulations to string
+
+Interactive doc available at https://mishankov.github.io/string-manipulator/docs
+
+Available manipulations:
+- Replace
+- Prepend
+- Append
+- Split, get from index
+- Compose
+- Slice
+- Split-compose
+- Split-join