Update readme

README.md

@@ -14,37 +14,32 @@ pinned: false
 
 # Measurement Card for Cooccurrence Count
 
-***Module Card Instructions:*** *Fill out the following subsections. Feel free to take a look at existing measurement cards if you'd like examples.*
-
 ## Measurement Description
-*Give a brief overview of this measurement, including what task(s) it is usually used for, if any.*
+The `cooccurence_count` measurement returns the total count of sentences in data and the co-occurrence count of the two words passed
 
 ## How to Use
-*Give general statement of how to use the measurement*
-
-*Provide simplest possible example for using the measurement*
+This measuresment requires a list of strings as input data along with two strings as word1 and word2
+```python
+>>> data = ["hello sun","hello moon", "hello sun"]
+>>> c_count = evaluate.load("prb977/cooccurrence_count")
+>>> results = c_count.compute(references=data, word1='hello', word2='sun')
+>>> 
+```
 
 ### Inputs
-*List all input arguments in the format below*
-- **input_field** *(type): Definition of input, with explanation if necessary. State any default value(s).*
+- **data** (list of `str`): The input list of strings
+- **word1** (`str`): The first word
+- **word2** (`str`): The second word
 
 ### Output Values
-
-*Explain what this measurement outputs and provide an example of what the measurement output looks like. Modules should return a dictionary with one or multiple key-value pairs, e.g. {"bleu" : 6.02}*
-
-*State the range of possible values that the measurement's output can take, as well as what in that range is considered good. For example: "This measurement can take on any value between 0 and 100, inclusive. Higher scores are better."*
-
-#### Values from Popular Papers
-*Give examples, preferrably with links to leaderboards or publications, to papers that have reported this measurement, along with the values they have reported.*
+- **count** (`int`): The total count of sentences in data.
+- **co_occurrence_count** (`int`): The count of co-occurrence of word1 and word2 in the sentences of data.
 
 ### Examples
-*Give code examples of the measurement being used. Try to include examples that clear up any potential ambiguity left from the measurement description above. If possible, provide a range of examples that show both typical and atypical results, as well as examples where a variety of input parameters are passed.*
-
-## Limitations and Bias
-*Note any known limitations or biases that the measurement has, with links and references if possible.*
-
-## Citation
-*Cite the source where this measurement was introduced.*
-
-## Further References
-*Add any useful further references.*
+```python
+>>> data = ["hello sun","hello moon", "hello sun"]
+>>> c_count = evaluate.load("prb977/cooccurrence_count")
+>>> results = c_count.compute(references=data, word1='hello', word2='sun')
+>>> print(results)
+{'count': 3, 'co_occurrence_count': 2}
+```