Update README.md

README.md

@@ -1,3 +1,32 @@
 ---
+language: ja
+
 license: cc-by-sa-4.0
 ---
+
+# Electra Base Japanese Irony  
+
+This is an [ELECTRA](https://github.com/google-research/electra) Base model for the Japanese language finetuned for automatic irony detection. 
+
+The model was based on [transformers-ud-japanese-electra-ginza](https://huggingface.co/megagonlabs/transformers-ud-japanese-electra-base-discriminator/tree/main), and later finetuned on a dataset containing ironic and sarcastic tweets. 
+
+
+## Licenses
+
+The finetuned model with all attached files is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/), or Creative Commons Attribution-ShareAlike 4.0 International License. 
+
+<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a>
+
+## Citations
+
+Please, cite this model using the following citation.
+
+```
+@inproceedings{dan2022electra-base-irony,
+  title={北見工業大学 テキスト情報処理研究室 ELECTRA Base 皮肉検出モデル (Megagon Labs ver.)}, 
+  author={団　俊輔　and プタシンスキ ミハウ and ジェプカ ラファウ and 桝井 文人}, 
+  publisher={HuggingFace}, 
+  year={2022},
+  url = "https://huggingface.co/kit-nlp/bert-base-japanese-basic-char-v2-irony"
+}
+```