chore: Update README (#140)

Author: edgarrmondragon

README.md

@@ -33,13 +33,37 @@ Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
 
 ## Settings
 
-- [ ] `Developer TODO:` Declare tap settings here.
+| Setting    | Required | Default | Description                        |
+| :--------- | :------- | :------ | :--------------------------------- |
+| api_key    | True     | None    | API Key for Socket                 |
+| start_date | False    | None    | Earliest datetime to get data from |
 
 A full list of supported settings and capabilities is available by running: `tap-socketdev --about`
 
+### Builtin Settings
+
+The following settings are available to all taps.
+
+| Setting                           | Required | Default | Description                                                                                                                                                                                                                                               |
+| :-------------------------------- | :------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 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 additional dependency (through the `singer-sdk` `faker` extra or directly). |
+| faker_config.seed                 | False    | None    | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator                                                                                                                                 |
+| faker_config.locale               | False    | None    | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization                                                                                                                                     |
+| 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    | Configuration for BATCH message capabilities.                                                                                                                                                                                                             |
+| batch_config.encoding             | False    | None    | Specifies the format and compression of the batch files.                                                                                                                                                                                                  |
+| batch_config.encoding.format      | False    | None    | Format to use for batch files.                                                                                                                                                                                                                            |
+| batch_config.encoding.compression | False    | None    | Compression format to use for batch files.                                                                                                                                                                                                                |
+| batch_config.storage              | False    | None    | Defines the storage layer to use when writing batch files                                                                                                                                                                                                 |
+| batch_config.storage.root         | False    | None    | Root path to use when writing batch files.                                                                                                                                                                                                                |
+| batch_config.storage.prefix       | False    | None    | Prefix to use when writing batch files.                                                                                                                                                                                                                   |
+
 ### Source Authentication and Authorization
 
-- [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here.
+- [Creating and Managing API Tokens](https://docs.socket.dev/reference/creating-and-managing-api-tokens).
 
 ## Usage
 
@@ -55,12 +79,10 @@ tap-socketdev --config CONFIG --discover > ./catalog.json
 
 ## 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.
-
 ### Initialize your Development Environment
 
 ```bash
-pipx install poetry
+uv tool install poetry
 poetry install
 ```
 
@@ -83,14 +105,13 @@ poetry run tap-socketdev --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
-the file.
+Your project comes with a custom `meltano.yml` project file already created.
 
 Next, install Meltano (if you haven't already) and any needed plugins:
 
 ```bash
 # Install meltano
-pipx install meltano
+uv tool install meltano
 # Initialize meltano within this directory
 cd tap-socketdev
 meltano install