Skip to content

Commit

Permalink
[doc] added an example on how to use the development version in a dep…
Browse files Browse the repository at this point in the history
…endent package
  • Loading branch information
agnat committed Dec 30, 2012
1 parent 8078126 commit c67c793
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
14 changes: 12 additions & 2 deletions README.textile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ h1. mdns -- node.js Service Discovery

|_. Package: | mdns |
|_. Description: | multicast DNS service discovery |
|_. Version: | 1.1.0 |
|_. Version: | 2.0.0-dev |
|_. Installation: | @npm install mdns@ (see below) |
|_. Documentation: | "mdns user guide":http://agnat.github.com/node_mdns/user_guide.html |
|_. License: | "MIT":http://github.com/agnat/node_mdns/blob/master/LICENSE |
Expand Down Expand Up @@ -44,10 +44,20 @@ bc. npm install mdns

If you want to play with the latest source code, here is a more manual approach:

bc.. git clone http://github.com/agnat/node_mdns
bc. git clone http://github.com/agnat/node_mdns
cd node_mdns
npm link && npm test

In case you want to run or even publish your package using the development version of mdns you may set the version field to a tarball URL:

bc. { "name": "discomvobulator"
, "version": "0.0.1"
, "description": "covers all your discomvobulation needs"
, "dependencies":
{ "mdns": "https://github.com/agnat/node_mdns/tarball/master"
}
}

h2. Documentation

See the "user guide":http://agnat.github.com/node_mdns/user_guide.html.
Expand Down
12 changes: 11 additions & 1 deletion doc/README.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,20 @@ bc. npm install mdns

If you want to play with the latest source code, here is a more manual approach:

bc.. git clone http://github.com/agnat/node_mdns
bc. git clone http://github.com/agnat/node_mdns
cd node_mdns
npm link && npm test

In case you want to run or even publish your package using the development version of mdns you may set the version field to a tarball URL:

bc. { "name": "discomvobulator"
, "version": "0.0.1"
, "description": "covers all your discomvobulation needs"
, "dependencies":
{ "mdns": "https://github.com/agnat/node_mdns/tarball/master"
}
}

h2. Documentation

See the "user guide":<%- package.homepage + '/user_guide.html' %>.
Expand Down

0 comments on commit c67c793

Please sign in to comment.