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

- old
+ new

@@ -1,9 +1,9 @@ Koko Keyword Python Client ============ -A ruby client for the [Koko Keywords API](https://r.kokocares.org/koko_keywords/docs). The client handles caching to ensure very low latency. +A ruby client for the [Koko Keywords API](https://developers.kokocares.org). The client handles caching to ensure very low latency. ## Install ``` @@ -11,11 +11,11 @@ ``` ## Usage Set the `KOKO_KEYWORDS_AUTH` environment to the authentication string provided -by Koko (contact us at api@kokocares.org if you would like one). +by Koko. To get an api key, complete our [sign up form](https://r.kokocares.org/api_signup). ``` export KOKO_KEYWORDS_AUTH=username:password ``` @@ -47,9 +47,11 @@ 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).