README.md in noip-0.1 vs README.md in noip-0.2

- old
+ new

@@ -1,25 +1,32 @@ # noip +[![Gem Version](https://badge.fury.io/rb/noip.svg)](http://badge.fury.io/rb/noip) +[![Build Status](https://travis-ci.org/asellitt/noip.svg?branch=master)](https://travis-ci.org/asellitt/noip) +[![Code Climate](https://codeclimate.com/github/asellitt/noip/badges/gpa.svg)](https://codeclimate.com/github/asellitt/noip) +[![Test Coverage](https://codeclimate.com/github/asellitt/noip/badges/coverage.svg)](https://codeclimate.com/github/asellitt/noip/coverage) + A simple utility for updating [noip](https://www.noip.com/integrate/request) dynamic DNS records for when your router kinda shit. ## Usage ### Command Line Interface -You will need to provide your credentials and host to update as environment variables: +`noip` required three parameters: username, password, and host ```bash -NOIP_HOST=host.to.update NOIP_USERNAME=username NOIP_PASSWORD=h4h-t0tez-l3g1t noip +noip update -u username -p h4h-t0tez-l3g1t -h host.to.update ``` +See `noip help update` for more information + ### Crontab -As before, environment variables will need to be provided, here's a sample crontab that will run every 4 hours: +Here's a sample crontab entry that will schedule the update every 4 hours ```crontab -0 0,4,8,12,16,20 * * * NOIP_HOST=host.to.update NOIP_USERNAME=username NOIP_PASSWORD=h4h-t0tez-l3g1t noip +0 0,4,8,12,16,20 * * * noip update -u username -p h4h-t0tez-l3g1t -h host.to.update ``` ## Contributing 1. Fork it ( https://github.com/asellitt/noip/fork )