Add README.md

kamali-sina · Jun 22, 2023 · 67f0ebc · 67f0ebc
1 parent d3362b1
commit 67f0ebc
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# meaningsearch
+
+A simple package that helps you find meaningful lines of any given input. Especially useful in CTFs.
+
+## How to install
+
+Simply run:
+
+    cargo install meaningsearch
+
+to install the package.
+
+## How to use
+
+You can encode an image using the command below:
+
+    stegomage -e -i <path-to-image>
+
+And you can decode an image using this command:
+
+    stegomage -d -i <path-to-image>