diff --git a/README.md b/README.md index 8ac2e8e..a30a712 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,25 @@
-## Note: +![ortho dictionary in action](./ortho_snap.png) -- The codebase is in alpha stage. +
+ +# Features: + +- Ove 21000 words directly taken from bangla academy dictionary. +- Super fast word lookup based on hash-map and sqlite database. + +
+ +# 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 new file mode 100644 index 0000000..a7c62e4 Binary files /dev/null and b/ortho_snap.png differ