README.md in koko_keywords-0.1.0 vs README.md in koko_keywords-0.2.0

- old
+ new

@@ -1,11 +1,10 @@ -Koko Keyword Python Client +Koko Keyword Ruby Client ============ A ruby client for the [Koko Keywords API](https://developers.kokocares.org). The client handles caching to ensure very low latency. - ## Install ``` gem install koko_keywords ``` @@ -30,32 +29,22 @@ ```py KokoKeywords.match("sewerslide") ``` -There are two optional params, `filter` and `version`. +There is one optional params, `filter`. ### Filter Filter the keyword based on the taxonomy using a colon delimited list of “dimension=value” filters. Omitting a dimension does not filter by that dimension e.g. ```py KokoKeywords.match("sewerslide", filter: "category=eating,parenting:confidence=1,2") ``` This matches "sewerslide" against eating eating and parenting, with a confidence of 1 and 2 and any intensity (as intensity was omitted). -### Version -Use this to pin to a specific version of the regex otherwise the endpoint returns the latest. e.g. - -```py -KokoKeywords.match("sewerslide", version: "20220206") -``` - -We do not recommend setting this as we frequently update keywords for better matching performance. - ## Performance The underlying library is written in Rust and cross-compiled to the four major CPU targets. Regexes are cached based on the cache expiration headers (currently set to an hour). This ensures very low latency and overhead (< 1μs/req). - ## Error Handling A RuntimeError will be raised with hints on how to resolve the issue. No exception handling should be necessary. ## Logging