Skip to content

Commit 42f95d8

Browse files
committed
Update README.md to include instructions for initializing a new Connector SDK project and emphasize configuration requirements before running fivetran debug.
1 parent 7b615aa commit 42f95d8

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

bright_data_unlocker/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,14 @@ This connector syncs web page content from Bright Data's Web Unlocker API to you
1616

1717
Refer to the [Connector SDK Setup Guide](https://fivetran.com/docs/connector-sdk/setup-guide) to get started.
1818

19-
Note: Ensure that the `configuration.json` file is not checked into version control to protect sensitive information.
19+
To initialize a new Connector SDK project using this connector as a starting point, run:
20+
21+
```bash
22+
fivetran init <project-path> --template connectors/bright_data_serp
23+
```
24+
```fivetran init``` initializes a new Connector SDK project by setting up the project structure, configuration files, and a connector you can run immediately with ```fivetran debug```. For more information on ```fivetran init```, refer to the [Connector SDK init documentation](https://fivetran.com/docs/connector-sdk/connector-development-and-configuration/connector-sdk-commands#fivetraninit).
25+
26+
Note: Ensure you have updated the `configuration.json` file with the necessary parameters before running `fivetran debug`. See the [Configuration file](https://github.com/fivetran/community_connectors/pull/41#configuration-file) section for details on the required configuration parameters.
2027

2128
## Features
2229

0 commit comments

Comments
 (0)