Merge pull request #108 from dzcode-io/98-add-readmemd-for-d-package

Add installation and usage instructions to README.md for kuliya package

Author: omdxp

README.md

@@ -21,7 +21,7 @@ You can find more about each language by clicking on the language name
 | [C#](./csharp)             | n/a                                                                                                    | n/a                                                                                               | n/a                                                                                                                      | n/a                                                                                                     |
 | [Rust](./rust)             | WIP                                                                                                    | WIP                                                                                               | WIP                                                                                                                      | n/a                                                                                                     |
 | [C](./c)             | ![](https://img.shields.io/conan/v/kuliya)                                                                                                  | ![](https://github.com/dzcode-io/kuliya/actions/workflows/c-checks.yml/badge.svg)                                                                                               | WIP                                                                                                                      | n/a                                                                                                     |
-| [D](./d)             | WIP                                                                                                    | WIP                                                                                               | WIP                                                                                                                      | n/a                                                                                                     |
+| [D](./d)             | ![DUB Version](https://img.shields.io/dub/v/kuliya)                                                                                                    | ![](https://github.com/dzcode-io/kuliya/actions/workflows/d-checks.yml/badge.svg)                                                                                               | WIP                                                                                                                      | n/a                                                                                                     |
 
 ## Contributing
 

d/README.md

@@ -2,6 +2,26 @@
 
 Algeria's college hierarchy dataset as a D package
 
+# Installation
+
+You can use `kuliya` package with one of these 2 options:
+
+1. Build it locally as it shown in [Get Started](#get-started) section then copy `kuliya.d` and `data.d` to your project.
+2. Use dub package manager in your DUB project by following these steps:
+    - Add `kuliya` dependency to your `dub.json`:
+    ```json
+    {
+        "name": "sandbox",
+        "dependencies": {
+            "kuliya:d": "~>1.0.0"
+        }
+    }
+    ```
+    - Run `dub build` to fetch and build the package.
+    - Use the package in your project.
+
+You can check the usage [here](#usage).
+
 # Prerequisites
 - One of these compilers:
   - [DMD](https://dlang.org/download.html#dmd) official compiler (works fine with dub)
@@ -26,6 +46,26 @@ cd d && dub test
 cd d/build && dub
 ```
 
+# Usage
+
+```d
+import std.stdio;
+import kuliya;
+
+void main()
+{
+    auto res = getNodeByPath("umkb/fst/dee/sec");
+    if (res is null)
+    {
+        writeln("Node not found");
+    }
+    else
+    {
+        writeln(res.name);
+    }
+}
+```
+
 # Contribute
 
 Feel free to ask for help in [#kuliya](https://dzcode.slack.com/archives/C01C0155CKC) group chat