diff --git a/crunchbase/README.md b/crunchbase/README.md index 324484c07..473464e9c 100644 --- a/crunchbase/README.md +++ b/crunchbase/README.md @@ -1,12 +1,31 @@ -# Template Quick Start Connector +# Crunchbase Connector -This is a _template_ for a simple quick start connector that return static data. This can serve as starting point for creating a brand new connector. +This package is a utility for connecting Cohere to Crunchbase. ## Configuration -This connector is very simple and only needs a `TEMPLATE_CONNECTOR_API_KEY` environment variable to be set. This value will be used for bearer token authentication to protect this connector from abuse. +The search connector requires the following environment variables: -A `.env-template` file is provided with all the environment variables that are used by this connector. +``` +CRUNCHBASE_API_KEY +``` + +This variable should contain the API key of the Crunchbase account. To get the API key, use the +instructions [here](https://www.crunchbase.com/account/integrations/crunchbase-api) + +``` +CRUNCHBASE_CONNECTOR_API_KEY +``` + +This variable is used to authenticate users using bearer token. + +### Optional configuration + +``` +CRUNCHBASE_SEARCH_LIMIT +``` + +This variable may contain the maximum number of results to return from Crunchbase. Default value is 20. ## Development @@ -28,9 +47,10 @@ and check with curl to see that everything is working ```bash $ curl --request POST \ --url http://localhost:5000/search \ + --header 'Authorization: Bearer <>' \ --header 'Content-Type: application/json' \ --data '{ - "query": "which species of penguin is the tallest?" + "query": "cohere ai" }' ```