updated readme

md-redwan-hossain · Oct 21, 2022 · 7241d74 · 7241d74
1 parent cee844f
commit 7241d74
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,8 +2,25 @@
 
 <br>
 
-## Note:
+![ortho dictionary in action](./ortho_snap.png)
 
-- The codebase is in alpha stage.
+<br>
+
+# Features:
+
+- Ove 21000 words directly taken from bangla academy dictionary.
+- Super fast word lookup based on hash-map and sqlite database.
+
+<br>
+
+# Steps to run Ortho Dictionary:
+
+**Ensure python (3.9+) is installed in your system then follow the following steps:**
+
+- Clone the repo or download the source codes.
+
+- Install the dependencies first: `pip3 install -r requirements.txt`
 
+- Then run YDM by this command: `python3 ortho.py`
 
+- The very first run may take some time because the of the extraction process of the sqlite database.
diff --git a/ortho_snap.png b/ortho_snap.png