aws secrets manager and parameter store providers added to read me (#186

) * aws secerets manager and parameter store providers added to read me * minor fix * third party providers section added * example readme's added * read me fixed
knadh · Jan 2, 2023 · 7c73646 · 7c73646
1 parent 35ff732
commit 7c73646
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -664,6 +664,12 @@ func main() {
 | providers/etcd     | `etcd.Provider(etcd.Config{})`                              | CNCF etcd provider                                                                                                                           |
 | providers/consul     | `consul.Provider(consul.Config{})`                              | Hashicorp Consul provider                                                                                                                           |
 
+### Third-party providers
+| Package             | Provider                                                      | Description                                                                                                                                                                           |
+| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| github.com/defensestation/koanf/providers/secretsmanager     | `vault.SecretsMananger(secretsmanager.Config{}, f func(s string) string)`                              | AWS Secrets Manager provider, takes map or string as a value from store                                                						  |
+| github.com/defensestation/koanf/providers/parameterstore     | `vault.ParameterStore(parameterstore.Config{}, f func(s string) string)`                              | AWS ParameterStore provider, an optional function that takes and returns a string to transform env variables                                                 						  |
+
 ### Bundled parsers
 
 | Package      | Parser                           | Description                                                                                                                                               |

diff --git a/examples/read-parameterstore/README.md b/examples/read-parameterstore/README.md
@@ -0,0 +1,4 @@
+# AWS Parameter Store Example
+
+## Link
+[example](https://github.com/defensestation/koanf/blob/main/examples/read-parameterstore/main.go)
diff --git a/examples/read-secretsmanager/README.md b/examples/read-secretsmanager/README.md
@@ -0,0 +1,4 @@
+# AWS Secrets Manager Example
+
+## Link
+[example](https://github.com/defensestation/koanf/blob/main/examples/read-secretsmanager/main.go)