Merge pull request #4 from conversationai/docs

Update documentation to match PREINSTALL changes.
conversationai · Mar 30, 2021 · f7c9bad · f7c9bad
2 parents b141cc4 + 0f64b83
commit f7c9bad
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -34,8 +34,8 @@ comment might have on a conversation by evaluating that comment across a range
 of emotional concepts, called attributes. When you install this extension, you
 will specify the attributes you want to receive scores for. Perspective's main
 attribute is TOXICITY, defined as "a rude, disrespectful, or unreasonable
-comment that is likely to make you leave a discussion". See a list of all
-available attributes [on our website](https://developers.perspectiveapi.com/s/about-the-api-attributes-and-languages).
+comment that is likely to make you leave a discussion". See a [list of all
+available attributes](https://developers.perspectiveapi.com/s/about-the-api-attributes-and-languages) on our developer site.
 Scores are retrieved when a new document is added to your collection or an
 existing document is modified.
 
@@ -46,7 +46,7 @@ Follow [the instructions on our Get Started page](https://developers.perspective
 to request API access and then [enable the API and create an API
 key](https://developers.perspectiveapi.com/s/docs-enable-the-api).
 
-By default, you're granted quota for 1 QPS to Perspective API. For additional
+By default, you're granted quota for 1 query per second (QPS) to Perspective API. For additional
 QPS, fill out a [quota increase
 request](https://developers.perspectiveapi.com/s/request-quota-increase) as needed.
 
@@ -55,7 +55,9 @@ you may exceed quota and the extension will fail to score your documents.
 
 #### Billing
 
-This extension uses other Firebase or Google Cloud services which may have associated charges:
+Perspective API is **free** for all amounts of quota. However, the extension
+uses Firebase and Google Cloud Platform services which may have associated
+charges, including:
 
 - Cloud Firestore
 - Cloud Functions
@@ -67,9 +69,6 @@ a Google Cloud API or making outbound network requests to non-Google services.
 All Firebase services offer a free tier of usage.
 [Learn more about Firebase billing.](https://firebase.google.com/pricing)
 
-Perspective API is free for all amounts of quota. Any costs associated with this
-extension come from the Firebase and Google Cloud Platform services listed above.
-
 **Configuration Parameters:**
 
 - Cloud Functions location: Where do you want to deploy the functions created for this extension? You usually want a location close to your database. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).

diff --git a/extension.yaml b/extension.yaml
@@ -18,12 +18,12 @@ specVersion: v1beta
 
 displayName: Analyze Toxicity with Perspective API
 description:
- Analyze the perceived impact a comment might have on a conversation using Perspective API.
+  Analyze the perceived impact a comment might have on a conversation using [Perspective API](https://perspectiveapi.com).
 
 license: Apache-2.0
 author:
- authorName: Perspective API
- url: https://perspectiveapi.com
+ authorName: Jigsaw
+ url: https://jigsaw.google.com
 
 billingRequired: true