Skip to content

Commit

Permalink
Clean up README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
watson committed Dec 30, 2015
1 parent 76ed5cb commit 41b11d9
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,6 @@ documentation](https://github.com/mafintosh/multicast-dns#mdns--multicastdnsopti

Allow the user to publish a new service on the network.

A service has the following properties:

- name: `'Apple TV'`
- type: `'airplay'`
- protocol: `'tcp'`
- host: `'hostname.local'`
- port: `5000`
- txt: `{...}` (optional)
- subtypes: `['api-v1']` (optional)

#### `var service = bonjour.publish(options)`

Publishes a new service.
Expand All @@ -67,7 +57,7 @@ Options are:
- `port` (number)
- `type` (string)
- `subtypes` (array of strings, optional)
- `protocol` (string, optional) - defaults to `tcp`
- `protocol` (string, optional) - `udp` or `tcp` (default)
- `txt` (object, optional) - a key/value object to broadcast as the TXT
record

Expand Down Expand Up @@ -177,6 +167,10 @@ property will be `Foo Bar._http._tcp.local`.
The TXT record advertised by the service (a key/value object). Note that
this property might be `null`.

#### `service.rawTxt`

The original raw Buffer of the txt record.

#### `service.published`

A boolean indicating if the service is currently published.
Expand Down

0 comments on commit 41b11d9

Please sign in to comment.