summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRodrigo Coutinho <rodrigo.coutinho@locaweb.com.br>2017-11-30 13:23:25 -0200
committerRodrigo Coutinho <rodrigo.coutinho@locaweb.com.br>2017-11-30 13:23:25 -0200
commit55627d4ec4b8ef1696248d7cc7851ae04512b5a2 (patch)
tree415ea3e0a9b2f345a821f76bf16a4c6495ad66f5
parentConfiguration instructions on readme (diff)
Improve readme
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index ca8c2df..6489221 100644
--- a/README.md
+++ b/README.md
@@ -22,13 +22,20 @@ If [available in Hex](https://hex.pm/docs/publish), the package can be installed
end
```
-## Configuration with env vars
-Insert this in your Phoenix configuration files. Eg: `config.exs`
+## Configuration
+Insert this in your configuration files. Eg: `config.exs`
+
+```elixir
+config :powerdnsex, url: "localhost:8081",
+ token: "sometoken"
+```
+
+You can also use ENV vars to configure PowerDNSex.
```elixir
config :powerdnsex, url: {:system, "POWERDNS_URL"},
token: {:system, "POWERDNS_TOKEN"}
```
-Make sure you set those envinronment variables.
+Make sure you set those environment variables.
## Example usage
@@ -101,3 +108,4 @@ record = %{
rrset = PowerDNSex.show_record("example.com", record)
res = PowerDNSex.delete_record(zone, rrset)
```
+