changes

README.md

@@ -85,6 +85,36 @@ Hindi
 | original         | 76025 |  10861 | 21722|
 | collapsed        | 76025 |  10861 | 21722|
 
+## About
+
+This repository contains the Hindi Named Entity Recognition dataset (HiNER) published at the Langauge Resources and Evaluation conference (LREC) in 2022. 
+
+### Recent Updates
+* Version 0.0.5: HiNER initial release
+
+## Usage
+
+You should have the 'datasets' packages installed to be able to use the :rocket: HuggingFace datasets repository. Please use the following command and install via pip:
+
+```code
+    pip install datasets
+```
+
+To use the original dataset with all the tags, please use:<br/>
+
+```python
+    from datasets import load_dataset
+    hiner = load_dataset('cfilt/HiNER-original')
+```
+
+To use the collapsed dataset with only PER, LOC, and ORG tags, please use:<br/>
+
+```python
+    from datasets import load_dataset
+    hiner = load_dataset('cfilt/HiNER-collapsed')
+```
+However, the CoNLL format dataset files can also be found on this Git repository under the [data](data/) folder.
+This dataset can be imported by executing:
 
 ## Dataset Creation