Browse files

fix register doc

  • Loading branch information...
1 parent bdfaa4d commit c0d4aa4fb0b6dadd17abcb87023a24a558b218af @soldair committed Feb 19, 2014
Showing with 11 additions and 2 deletions.
  1. +11 −2 README.md
View
13 README.md
@@ -1,4 +1,3 @@
-
s3-service-registry
===================
@@ -47,7 +46,17 @@ instance = ctor(s3key,s3secret,bucket)
```
## instance methods
-register(service)
+### register(service,host,port,data,cb)
+ - service
+ the name of the service
+ - host
+ the host name which can be accessed by people looking for the service
+ - port
+ the service port
+ - data (optional)
+ an object of custom data you would like to store in the service file
+ - cb
+ callback
### online(service,check,cb)
- service (optional)

0 comments on commit c0d4aa4

Please sign in to comment.