Permalink
Browse files

just added some files

  • Loading branch information...
1 parent 1c9dc9c commit ac106f3482ea00b17aa14b9e211e1b5a79c817e4 @kersten committed Jul 13, 2012
Showing with 111 additions and 1 deletion.
  1. +34 −0 LICENSE
  2. +52 −1 README.md
  3. +1 −0 index.js
  4. 0 lib/dyndns-client.js
  5. +24 −0 package.json
View
34 LICENSE
@@ -0,0 +1,34 @@
+Copyright 2012, Kersten Burkhardt (the "Original Author")
+All rights reserved.
+
+MIT +no-false-attribs License
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+Distributions of all or part of the Software intended to be used
+by the recipients as they would use the unmodified Software,
+containing modifications that substantially alter, remove, or
+disable functionality of the Software, outside of the documented
+configuration mechanisms provided by the Software, shall be
+modified such that the Original Author's bug reporting email
+addresses and urls are either replaced with the contact information
+of the parties responsible for the changes, or removed entirely.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,4 +1,55 @@
node-dyndns-client
==================
-A dynamic dns client for updating IPs
+A dynamic dns client for updating IPs
+
+Options
+-------
+ var options = {
+ url: "http://members.dyndns.org/",
+ hostnames: [
+ "test.dyndns.org",
+ "customtest.dyndns.org"
+ ],
+ username: 'username',
+ password: 'password',
+ interface: 'ppp0',
+ protocol: 'ipv4',
+ check: 60
+ };
+
+Usage
+-----
+ var DynDNSClient = require("node-dyndns-client"),
+ dyndns = new DynDNSClient({
+ url: "http://members.dyndns.org/",
+ hostnames: [
+ "test.dyndns.org",
+ "customtest.dyndns.org"
+ ],
+ username: 'username',
+ password: 'password',
+ interface: 'ppp0',
+ protocol: 'ipv4',
+ check: 60
+ });
+
+ dyndns.on('IP:changed', function (newIP, oldIP) {
+ // IP has changed
+ });
+
+ dyndns.on('interface:up', function () {
+ // Networkinterface up
+ });
+
+ dyndns.on('interface:down', function () {
+ // Networkinterface down
+ });
+
+ dyndns.on('update:success', function () {
+ // Update at services succeeded
+ });
+
+ dyndns.on('update:error', function (err) {
+ // Update at services failed
+ });
View
@@ -0,0 +1 @@
+module.exports = require('./lib/dyndns-client');
View
No changes.
View
@@ -0,0 +1,24 @@
+{
+ "version": "0.1.0",
+ "name": "node-dyndns-client",
+ "description": "A dynamic dns IP updater",
+ "homepage": "http://github.com/kersten/node-dyndns-client",
+ "author": "Kersten Burkhardt <kerstenk@gmail.com> (http://github.com/kersten)",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/kersten/node-dyndns-client"
+ },
+ "bugs": {
+ "email": "kerstenk@gmail.com",
+ "url": "http://github.com/kersten/node-dyndns-client/issues"
+ },
+ "engines": {
+ "node": ">0.6"
+ },
+ "licenses": [
+ {
+ "type": "MIT +no-false-attribs",
+ "url": "http://github.com/kersten/node-dndns-client/raw/master/LICENSE"
+ }
+ ]
+}

0 comments on commit ac106f3

Please sign in to comment.