Update README.md

README.md

@@ -1,3 +1,24 @@
 ---
 license: apache-2.0
 ---
+
+# Dataset details
+Each entry in this dataset is a sentence-aligned Japanese web novel chapter and English fan translation.
+The intended use-case is for document translation tasks.
+
+# Dataset format
+```json
+{
+  'src' : 'JAPANESE CHAPTER'
+  'trg' : 'ENGLISH TRANSLATION'
+  'meta' : {
+    "source": 'SAME ACROSS ALL ENTRIES',
+    "series": 'NAME OF WEB NOVEL SERIES',
+    "missed_lines": 'NUMBER OF LINES THAT WERE AT THE SAME INDEX BUT NOT DETECTED AS BEING TRANSLATIONS OF EACH OTHER',
+    "inserted_lines_src":  'NUMBER OF LINES IN THE JAPANESE TEXT THAT DID NOT HAVE A MATCHING TRANSLATION BUT ARE BUFFERED BY TRANSLATED LINES',
+    "inserted_lines_trg":  'SAME AS ABOVE BUT FOR ENGLISH',
+    }
+}
+```
+A high number of inserted lines is not necessarily sign of a bad pair, as many translations concatentate or splice source chapters when publishing. 
+Instead, watch out for high numbers of missed lines or entries where the inserted liens is high for both source and target.