README.md in sant0sk1-dreamy-0.2.4 vs README.md in sant0sk1-dreamy-0.3.0
- old
+ new
@@ -44,10 +44,13 @@
account.users
# fetch an array of Dreamy::Dns objects
account.dns
+ # fetch an array of Dreamy::AnnounceList objects
+ account.announce_lists
+
# fetch an array of Dreamy::Subscribers to an announcement list
account.announce_list(listname,domain)
You can interact with announcement lists by adding and removing subscribers
@@ -55,10 +58,18 @@
account.announce_add(listname,domain,email)
# remove a subscriber from an announcement list
account.announce_remove(listname,domain,email)
+You can interact with DNS by adding and removing records
+
+ # add a new A record for a subdomain of an hosted domain
+ account.dns_add(subdomain,"A","123.321.123.321")
+
+ # remove the A record just created
+ account.dns_remove(subdomain,"A","123.321.123.321")
+
More and more functions will be added as time allows. If there's something missing that you want in, please:
fork -> commit -> pull request
Command Line Usage
@@ -86,30 +97,33 @@
dh help
=== Commands
help # show this usage
- domains:http # list HTTP domain details
- domains:mysql # list MySQL domains
- domains:status # check availability of all domains (pingability)
+ domains:http # list HTTP domain details
+ domains:mysql # list MySQL domains
+ domains:status # check availability of all domains (pingability)
- dns # list DNS records
- dns <name> # list DNS records for <name>
+ dns # list DNS records
+ dns <name> # list DNS records for <name>
+ dns:add <record> <type> <value> # add DNS record
+ dns:remove <record> <type> <value> # remove DNS record
- announce:list <list> # lists all subscribers to <name> list (eg - 'my_list@example.com')
- announce:add <list> <email> # add subscriber with <email> to <list>
- announce:remove <list> <email> # remove subscriber with <email> from <list>
+ announce # list announce lists
+ announce:list <list> # list all subscribers to <name> list
+ announce:add <list> <email> # add subscriber with <email> to <list>
+ announce:remove <list> <email> # remove subscriber with <email> from <list>
- users # list user accounts: details
- users:pw # list user accounts: usernames & passwords
+ users # list user accounts: details
+ users:pw # list user accounts: usernames & passwords
That's it for now. New commands should be springing up as Dreamy and the DreamHost API mature!
TODO
====
-* more tests
+* add PS commands (once DH creates test account)
* add real rdocs
[1]:http://github.com/sant0sk1/dreamy
[2]:http://wiki.Dreamy.com/API
\ No newline at end of file