chore: update readme

README.md

@@ -4,39 +4,49 @@
 
 Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
 
-<!--
-
-Developer TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
-
 ## Installation
 
-Install from PyPi:
-
-```bash
-pipx install tap-superset
-```
 
 Install from GitHub:
 
 ```bash
 pipx install git+https://github.com/ORG_NAME/tap-superset.git@main
 ```
 
--->
-
 ## Configuration
 
 ### Accepted Config Options
 
-<!--
-Developer TODO: Provide a list of config options accepted by the tap.
+# `tap-superset`
 
-This section can be created by copy-pasting the CLI output from:
+Superset tap class.
 
-```
-tap-superset --about --format=markdown
-```
--->
+Built with the [Meltano Singer SDK](https://sdk.meltano.com).
+
+## Capabilities
+
+* `catalog`
+* `state`
+* `discover`
+* `about`
+* `stream-maps`
+* `schema-flattening`
+* `batch`
+
+## Settings
+
+| Setting             | Required | Default | Description |
+|:--------------------|:--------:|:-------:|:------------|
+| username            | True     | None    | Username of the db user that has access to superset api |
+| password            | True     | None    | Password    |
+| start_date          | False    | None    | The earliest record date to sync |
+| base_url            | True     | https://superset.com | The url for the API service |
+| stream_maps         | False    | None    | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
+| stream_map_config   | False    | None    | User-defined config values to be used within map expressions. |
+| faker_config        | False    | None    | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly). |
+| flattening_enabled  | False    | None    | 'True' to enable schema flattening and automatically expand nested properties. |
+| flattening_max_depth| False    | None    | The max depth to flatten schemas. |
+| batch_config        | False    | None    |             |
 
 A full list of supported settings and capabilities for this
 tap is available by running:
@@ -53,10 +63,10 @@ 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.
--->
+tap-superset uses the /api/v1/security/login endpoint to get its Auth Token from superset.
 
+So it is necessary to set the username and password variables for Authentication.
+The user provided should have access to the superset API and you can create it with the superset cli
 ## Usage
 
 You can easily run `tap-superset` by itself or in a pipeline using [Meltano](https://meltano.com/).
@@ -100,11 +110,6 @@ poetry run tap-superset --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._
 
-<!--
-Developer TODO:
-Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any "TODO" items listed in
-the file.
--->
 
 Next, install Meltano (if you haven't already) and any needed plugins: