From f463f9a318d7eb9d9ab49e1e96fa9941738c492d Mon Sep 17 00:00:00 2001 From: Chad Phillips Date: Mon, 27 Nov 2017 09:57:15 -0700 Subject: Add usage examples to README --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/README.md b/README.md index 18dee79..8243116 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,68 @@ If [available in Hex](https://hex.pm/docs/publish), the package can be installed end ``` +## Example usage + +```elixir +# CREATE ZONE: +zone_model = %PowerDNSex.Models.Zone{ + id: "example.com.", + kind: "Master", + name: "example.com.", + serial: 1, +} +{:ok, zone} = PowerDNSex.create_zone(zone_model) + +# SHOW ZONE: +{:ok, zone} = PowerDNSex.show_zone("example.com") + +# DELETE ZONE: +res = PowerDNSex.delete_zone("example.com") + +# CREATE RECORD: +{:ok, zone} = PowerDNSex.show_zone("example.com") +record = %{ + name: "test.example.com.", + type: "A", + ttl: 60, + records: [ + %{ + content: "192.168.11.67", + disabled: false, + } + ] +} +res = PowerDNSex.create_record(zone, record) + +# SHOW RECORD: +record = %{ + name: "test.example.com.", + type: "A", +} +rrset = PowerDNSex.show_record("example.com", record) + +# UPDATE RECORD: +{:ok, zone} = PowerDNSex.show_zone("example.com") +record = %{ + name: "test.example.com.", + type: "A", + ttl: 60, + records: [ + %{ + content: "192.168.11.100", + disabled: false, + } + ] +} +res = PowerDNSex.update_record(zone, record) + +# DELETE RECORD: +{:ok, zone} = PowerDNSex.show_zone("example.com") +record = %{ + name: "test.example.com.", + type: "A", +} +rrset = PowerDNSex.show_record("example.com", record) +res = PowerDNSex.delete_record(zone, rrset) + +``` -- cgit v1.2.3