Skip to content

Commit

Permalink
Rename our binaries (#858)
Browse files Browse the repository at this point in the history
  • Loading branch information
reconbot authored Jun 17, 2016
1 parent 921d975 commit e7ad1c7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -503,10 +503,10 @@ Callback is called with an error object. This will always happen before a `close
If you install `serialport` globally. (eg, `npm install -g serialport`) you'll receive two command line tools.

### Serial Port List
`serialportlist` will list all available serial ports in different formats.
`serialport-list` will list all available serial ports in different formats.

```bash
$ serialportlist -h
$ serialport-list -h

Usage: serialport-list [options]

Expand All @@ -519,25 +519,25 @@ $ serialportlist -h
-f, --format <type> Format the output as text, json, or jsonline. default: text


$ serialportlist
$ serialport-list
/dev/cu.Bluetooth-Incoming-Port
/dev/cu.usbmodem1421 Arduino (www.arduino.cc)

$ serialportlist -f json
$ serialport-list -f json
[{"comName":"/dev/cu.Bluetooth-Incoming-Port"},{"comName":"/dev/cu.usbmodem1421","manufacturer":"Arduino (www.arduino.cc)","serialNumber":"752303138333518011C1","locationId":"0x14200000","vendorId":"0x2341","productId":"0x0043"}]

$ serialportlist -f jsonline
$ serialport-list -f jsonline
{"comName":"/dev/cu.Bluetooth-Incoming-Port"}
{"comName":"/dev/cu.usbmodem1421","manufacturer":"Arduino (www.arduino.cc)","serialNumber":"752303138333518011C1","locationId":"0x14200000","vendorId":"0x2341","productId":"0x0043"}
```

### Serial Port Terminal
`serialportterm` provides a basic terminal interface for communicating over a serial port. `ctrl+c` will exit.
`serialport-term provides a basic terminal interface for communicating over a serial port. `ctrl+c` will exit.

```bash
$ serialportterminal -h
$ serialport-term -h

Usage: serialport-terminal -p <port> [options]
Usage: serialport-term -p <port> [options]

A basic terminal interface for communicating over a serial port. Pressing ctrl+c exits.

Expand All @@ -553,7 +553,7 @@ $ serialportterminal -h
--stopbits <bits> Stop bits default: 1
--echo --localecho Print characters as you type them.

$ serialportterminal -l
$ serialport-term -l
/dev/cu.Bluetooth-Incoming-Port
/dev/cu.usbmodem1421 Arduino (www.arduino.cc)
```
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@
"node": ">= 0.10.0"
},
"bin": {
"serialportlist": "./bin/serialport-list.js",
"serialportterm": "./bin/serialport-terminal.js"
"serialport-list": "./bin/serialport-list.js",
"serialport-term": "./bin/serialport-terminal.js"
},
"license": "MIT",
"scripts": {
Expand Down

0 comments on commit e7ad1c7

Please sign in to comment.