Update Configuration instructions in README.md #457
Conversation
README.md
Outdated
| @@ -63,7 +63,7 @@ It's possible to use a function or a tuple to resolve the secret: | |||
| ```ex | |||
| config :stripity_stripe, api_key: {MyApp.Secrets, :stripe_secret, []} | |||
| # OR | |||
| config :stripity_stripe, api_key: fn -> System.get_env("STRIPE_SECRET") end | |||
| config :stripity_stripe, api_key: System.get_env("STRIPE_SECRET") | |||
There was a problem hiding this comment.
It's possible to use a function or a tuple to resolve the secret:
👋 @annaminton! Really appreciate the PR. So this is under an alternative configuration option. I asked @monorkin if he ended up using this option to set a config option just to make sure there are no issues.
The way you outlined here is the "main" way most people set their api_key, which is also documented above (partially). Perhaps we could change this PR to update the above config :stripity_stripe, api_key: "YOUR SECRET KEY" with what you have here? Lmk what you think.
There was a problem hiding this comment.
You are correct. I apologize for not reading the README more carefully. I honestly skipped over that part and went straight for the alternate configuration after spotting System.get_env.
I do think the vast majority of users will be setting their :stripe_secret via an environment variable so updating the "main" example probably makes sense.
There was a problem hiding this comment.
I've made that change. Take a look and let me know if you think this is adding any value. 🙌
As pointed out in #456, you don't need the function and can set the
api_keydirectly.