docs: explain provider usage in README

Signed-off-by: Giovanni De Giorgio <[email protected]>

Author: gioddiggi

libs/providers/aws-ssm/README.md

@@ -1,15 +1,41 @@
-# aws-ssm Provider
+# AWS SSM Provider
+
+## What is AWS SSM?
+AWS Systems Manager (SSM) is a service provided by Amazon Web Services (AWS) that enables users to manage and automate operational tasks across their AWS infrastructure. One of its key components is AWS Systems Manager Parameter Store, which allows users to store, retrieve, and manage configuration data and secrets securely.
+SSM Parameter Store can be used to manage application configuration settings, database connection strings, API keys, and other sensitive information. It provides integration with AWS Identity and Access Management (IAM) to control access and encryption through AWS Key Management Service (KMS).
+The aws-ssm provider for OpenFeature allows applications to fetch feature flag configurations from AWS SSM Parameter Store, enabling centralized and dynamic configuration management.
 
 ## Installation
 
 ```
 $ npm install @openfeature/aws-ssm-provider
 ```
 
-## Building
+## Set AWS Provider
 
-Run `nx package providers-aws-ssm` to build the library.
+```
+OpenFeature.setProvider(
+  new AwsSsmProvider({
+    ssmClientConfig: {
+      region: 'eu-west-1', // Change this to your desired AWS region
+      // You can setup your aws credentials here or it will be automatically retrieved from env vars
+      // See https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html
+    },
+    // Use an LRUCache for improve performance and optimize AWS SDK Calls to SSM (cost awareness)
+    cacheOpts: {
+      enabled: true, // Enable caching
+      size: 1, // Cache size
+      ttl: 10, // Time-to-live in seconds
+    },
+  })
+);
+```
+## Retrieve Feature Flag!
 
-## Running unit tests
+Create a new SSM Param called 'my-feature-flag' in your AWS Account and then retrieve it via OpenFeature Client!
 
-Run `nx test providers-aws-ssm` to execute the unit tests via [Jest](https://jestjs.io).
+```
+const featureFlags = OpenFeature.getClient();
+const flagValue = await featureFlags.getBooleanValue('my-feature-flag', false);
+console.log(`Feature flag value: ${flagValue}`);
+```