Update README.md

browser-extension/plugin/scripts/2023-12-21-slur-metadata/README.md

@@ -1,20 +1,58 @@
-## Metadata Annotations for Slur List
-
-All the metadata annotations and a few new slur contributions are present in the `slur_list.csv` file.
-These are the columns of the `slur_list.csv` file.
-
-```
-Slur Word   
-Annotator ID
-Level of Severity   
-Casual  
-Appropriated    
-If, Appropriated, Is it by Community or Others? 
-What Makes it Problematic?  
-Category 1  
-Category 2  
-Category 3  
-Category 4
-```
-
-The `Slur Word` column contains all the slur words. The `Annotator ID` contains the id for the contributor who annotated that slur, this ID is annynomized. All the other columns are metadata fields for the slur, a detailed explanation about them can be found in the `annotations guideline`.
+## 📋 A Guide to the Slur List
+The Uli plugin redacts slurs and abusive content. For it to do so, we began to crowdsource slur words which are used in online spaces to help detect and redact them on our user's feeds. 
+
+The Slur List was made in conjunction with gender and feminist rights organisations: Nazariya, Khabar Lahariya, Point of View and Feminism in India, who partnered with us to add to our database of slur words and contribute to metadata on the slurs by participating in online annotation sessions. We've held sessions with members from the organisation, as well as researchers and activists in the space who were interested in helping us expand our database. 
+
+At present the slur list consists of **630 words** in **4 languages**: Indian-English, Hindi, Tamil and Malayalam.  
+
+Our annotation sesssions involve online meetings with annotators who, over the duration of an hour, annotate and provide context on the meaning and usage of slurs in everyday life on an excel sheet we share with them. We also encourage participants to interact and discuss aspects of annotations as they do so, and find it improves ease of annotation and provides a sense of cohesiveness to the exercise.
+
+Separately, the plugin has also been updated to allow users to participate in crowdsourcing as well:
+[image]
+
+A user can add slurs they encounter which they believe should have been redacted, and also shows them their list of slurs over the course of time as they add more. This list is custom to each user, and the slurs they contribute may be incorporated to our slur list database as well.
+
+📩 We are actively looking to work with more partner organisations as well to continue our work in a sustained manner- so if you're interested in partnering with us, do reach out!
+
+**🧭 How to navigate the slur list:**
+
+All the metadata annotations and a few new slur contributions are present in the [data.csv](https://github.com/tattle-made/Uli/blob/1760d01660dc5e7c20453edbe580e9315382c691/browser-extension/plugin/scripts/2023-12-21-slur-metadata/data.csv) file. These categories of metadata which have been annotated under are the following columns of the [data.csv](https://github.com/tattle-made/Uli/blob/1760d01660dc5e7c20453edbe580e9315382c691/browser-extension/plugin/scripts/2023-12-21-slur-metadata/data.csv) file:
+
+- Slur Word
+
+- Annotator ID
+
+- Level of Severity
+
+- Casual
+
+- Appropriated
+
+- If, Appropriated, Is it by Community or Others?
+
+- What Makes it Problematic?
+
+- Type of slur: 
+
+    - Category 1 (ex:gendered)
+
+    - Category 2 (ex:sexualised)
+
+    - Category 3 (ex:casteist)
+
+    - Category 4 (ex:ableist)
+
+The Slur Word column contains all the slur words. The Annotator ID contains the id for the contributor who annotated that slur, this ID is anynomized. All the other columns are metadata fields for the slur, a detailed explanation about them can be found in the annotation guideline.
+
+**🤔 Which list do I use?**
+
+The slur lists are available on our Github repo [here](https://github.com/tattle-made/Uli/tree/1760d01660dc5e7c20453edbe580e9315382c691/browser-extension/plugin/scripts)
+
+The first version of the slur list from our work in 2023, released under the Open Data License, is available [here](https://github.com/tattle-made/Uli/blob/1760d01660dc5e7c20453edbe580e9315382c691/browser-extension/plugin/scripts/slur-list.txt)
+
+If you'd like to view the slur list with the metadata annotations, and new slur contributions, you can take a look [here] ([https://github.com/tattle-made/Uli/tree/main/browser-extension/plugin/scripts/2023-12-21-slur-metadata](https://github.com/tattle-made/Uli/blob/1760d01660dc5e7c20453edbe580e9315382c691/browser-extension/plugin/scripts/2023-12-21-slur-metadata/data.csv))
+
+**𖡎 Feedback:**
+
+We'd love to have your input on the slur list. Drop us a comment on the Discussions section 
+[here](https://github.com/tattle-made/Uli/discussions/605) 💬