Update README.md

README.md

@@ -2,6 +2,7 @@
 language: 
   - es
 
+library_name: pysentimiento
 tags:
   - twitter
   - named-entity-recognition
@@ -17,6 +18,25 @@ Repository: [https://github.com/pysentimiento/pysentimiento/](https://github.com
 Model trained with the Spanish/English split of the [LinCE NER corpus](https://ritual.uh.edu/lince/), a code-switched benchmark . Base model is [RoBERTuito](https://github.com/pysentimiento/robertuito), a RoBERTa model trained in Spanish tweets.
 
 
+## Usage
+
+If you want to use this model, we suggest you use it directly from the `pysentimiento` library as it is not working properly with the pipeline due to tokenization issues
+
+```python
+from pysentimiento import create_analyzer
+
+ner_analyzer = create_analyzer("ner", lang="es")
+
+ner_analyzer.predict("rindanse ante el mejor, leonel andres messi cuccitini. serresiete no existis, segui pastando camellos en el al-nassr")
+ 
+
+# [{'type': 'PER',
+#   'text': 'leonel andres messi cuccitini',
+#   'start': 24,
+#   'end': 53},
+#  {'type': 'PER', 'text': 'serresiete', 'start': 55, 'end': 65},
+#  {'type': 'LOC', 'text': 'al-nassr', 'start': 108, 'end': 116}]
+```
 
 ## Results