diff --git a/docs/connector-development/README.md b/docs/connector-development/README.md index 0109e43a428b..cb38d961aa88 100644 --- a/docs/connector-development/README.md +++ b/docs/connector-development/README.md @@ -6,9 +6,13 @@ To build a new connector in Java or Python, we provide templates so you don't ne **Note: you are not required to maintain the connectors you create.** The goal is that the Airbyte core team and the community help maintain the connector. -## Connector-Development Kit (CDK) +## Python Connector-Development Kit (CDK) -You can build a connector very quickly with the [Airbyte CDK](cdk-python/README.md), which generates 75% of the code required for you. +You can build a connector very quickly in Python with the [Airbyte CDK](cdk-python/README.md), which generates 75% of the code required for you. + +## TS/JS Connector-Development Kit (Faros AI Airbyte CDK) + +You can build a connector in TypeScript/JavaScript with the [Faros AI CDK](./cdk-faros-js/README.md), which generates and boostraps most of the code required for HTTP Airbyte sources. ## The Airbyte specification diff --git a/docs/connector-development/cdk-faros-js/README.md b/docs/connector-development/cdk-faros-js/README.md new file mode 100644 index 000000000000..18820a4bcf82 --- /dev/null +++ b/docs/connector-development/cdk-faros-js/README.md @@ -0,0 +1,11 @@ +# Connector Development Kit (TypeScript/JavaScript) + +The [Faros AI TypeScript/JavaScript CDK](https://github.com/faros-ai/airbyte-connectors/tree/main/faros-airbyte-cdk) allows you to build Airbyte connectors quickly similarly to how our [Python CDK](../cdk-python) does. This CDK currently offers support for creating Airbyte source connectors for: + +- HTTP APIs + +## Resources + +[This document](https://github.com/faros-ai/airbyte-connectors/blob/main/sources/README.md) is the main guide for developing an Airbyte source with the Faros CDK. + +An example of a source built with the Faros AI CDK can be found [here](https://github.com/faros-ai/airbyte-connectors/tree/main/sources/example-source). It's recommended that you follow along with the example source while building for the first time. \ No newline at end of file