diff --git a/cookiecutter/tap-template/{{cookiecutter.tap_id}}/README.md b/cookiecutter/tap-template/{{cookiecutter.tap_id}}/README.md index f727a3de9..37c94d0fd 100644 --- a/cookiecutter/tap-template/{{cookiecutter.tap_id}}/README.md +++ b/cookiecutter/tap-template/{{cookiecutter.tap_id}}/README.md @@ -4,19 +4,39 @@ Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps. + + ## Configuration ### Accepted Config Options -- [ ] `Developer TODO:` Provide a list of config options accepted by the tap. + A full list of supported settings and capabilities for this tap is available by running: @@ -33,7 +53,9 @@ environment variable is set either in the terminal context or in the `.env` file ### Source Authentication and Authorization -- [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here. + ## Usage @@ -49,7 +71,7 @@ You can easily run `{{ cookiecutter.tap_id }}` by itself or in a pipeline using ## Developer Resources -- [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed. +Follow these instructions to contribute to this project. ### Initialize your Development Environment @@ -78,8 +100,11 @@ poetry run {{cookiecutter.tap_id}} --help _**Note:** This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios._ -Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any _"TODO"_ items listed in + Next, install Meltano (if you haven't already) and any needed plugins: diff --git a/cookiecutter/target-template/{{cookiecutter.target_id}}/README.md b/cookiecutter/target-template/{{cookiecutter.target_id}}/README.md index 0fb9f105e..745d45b1f 100644 --- a/cookiecutter/target-template/{{cookiecutter.target_id}}/README.md +++ b/cookiecutter/target-template/{{cookiecutter.target_id}}/README.md @@ -4,19 +4,39 @@ Build with the [Meltano Target SDK](https://sdk.meltano.com). + + ## Configuration ### Accepted Config Options -- [ ] `Developer TODO:` Provide a list of config options accepted by the target. + A full list of supported settings and capabilities for this target is available by running: @@ -33,7 +53,9 @@ environment variable is set either in the terminal context or in the `.env` file ### Source Authentication and Authorization -- [ ] `Developer TODO:` If your target requires special access on the source system, or any special authentication requirements, provide those here. + ## Usage @@ -50,7 +72,7 @@ tap-carbon-intensity | {{ cookiecutter.target_id }} --config /path/to/{{ cookiec ## Developer Resources -- [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed. +Follow these instructions to contribute to this project. ### Initialize your Development Environment @@ -79,8 +101,11 @@ poetry run {{cookiecutter.target_id}} --help _**Note:** This target will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios._ -Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any _"TODO"_ items listed in + Next, install Meltano (if you haven't already) and any needed plugins: