Merge pull request #17 from getindata/docs/readme_update

docs: Update readme

README.md

@@ -15,9 +15,9 @@ Terraform module for creating Snowflake user.
 
 This module can:
 
-* Create and manage Snowflake Users
-* Automatically generate RSA private and public keys for the User
-* Automatically grant `default_role` and `default_secondary_roles` to the User
+- Create and manage Snowflake Users
+- Automatically generate RSA private and public keys for the User
+- Automatically grant `default_role` and `default_secondary_roles` to the User
 
 ## Usage
 
@@ -28,22 +28,57 @@ module "terraform_snowflake_user" {
 }
 ```
 
+## EXAMPLES
+
+- [Simple](examples/simple) - Basic usage of the module
+- [Complete](examples/complete) - Advanced usage of the module
+
 ## Breaking changes in v2.x of the module
 
 Due to breaking changes in Snowflake provider and additional code optimizations, **breaking changes** were introduced in `v2.0.0` version of this module.
 
 List of code and variable (API) changes:
 
-* Support for Snowflake user types, managed by `type` variable
-* Clear differentiation of `PERSON`, `SERVICE` and `LEGACY_SERVICE` users
-* `snowflake_default_secondary_roles` changed to `snowflake_default_secondary_roles_option` (string)
-* Added `middle_name`, `query_tag`, `timezone`, `network_policy`, `trace_level`, `log_level` and `enable_unredacted_query_syntax_error` variables
-* Added `disable_mfa` flag (`false` by default), that handles MFA enforcement for `PERSON` users
+- Support for Snowflake user types, managed by `type` variable
+- Clear differentiation of `PERSON`, `SERVICE` and `LEGACY_SERVICE` users
+- `snowflake_default_secondary_roles` changed to `snowflake_default_secondary_roles_option` (string)
+- Added `middle_name`, `query_tag`, `timezone`, `network_policy`, `trace_level`, `log_level` and `enable_unredacted_query_syntax_error` variables
+- Added `disable_mfa` flag (`false` by default), that handles MFA enforcement for `PERSON` users
 
 When upgrading from `v1.x`, expect most of the resources to be recreated - if recreation is impossible, then it is possible to import some existing resources.
 
 For more information, refer to [variables.tf](variables.tf), list of inputs below and Snowflake provider documentation
 
+## Breaking changes in v3.x of the module
+
+Due to replacement of nulllabel (`context.tf`) with context provider, some **breaking changes** were introduced in `v3.0.0` version of this module.
+
+List od code and variable (API) changes:
+
+- Removed `context.tf` file (a single-file module with additonal variables), which implied a removal of all its variables (except `name`):
+  - `descriptor_formats`
+  - `label_value_case`
+  - `label_key_case`
+  - `id_length_limit`
+  - `regex_replace_chars`
+  - `label_order`
+  - `additional_tag_map`
+  - `tags`
+  - `labels_as_tags`
+  - `attributes`
+  - `delimiter`
+  - `stage`
+  - `environment`
+  - `tenant`
+  - `namespace`
+  - `enabled`
+  - `context`
+- Remove support `enabled` flag - that might cause some backward compatibility issues with terraform state (please take into account that proper `move` clauses were added to minimize the impact), but proceed with caution
+- Additional `context` provider configuration
+- New variables were added, to allow naming configuration via `context` provider:
+  - `context_templates`
+  - `name_schema`
+
 <!-- BEGIN_TF_DOCS -->