diff --git a/README.md b/README.md index f1bd138..a3df4c8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ # can2x +`can2x` is a simple utility for connecting a can bus unidirectional with another can bus over the network using common web protocols, such as HTTP, MQTT, Socket.IO, and WebSockets. +This project is a research prototype and should not be used in production. + +``` +Usage: can2x [options] [command] + +can2x is a simple utility for connecting a can bus unidirectional with another can bus over the network using common web protocols, such as HTTP, MQTT, Socket.IO, and WebSockets. + +Options: + -h, --help display help for command + +Commands: + bridge manages a can2x bridge + vcan manages a vcan + help [command] display help for command +``` + +``` +Usage: can2x bridge [options] [command] + +manages a can2x bridge + +Options: + -h, --help display help for command + +Commands: + start [options] starts a can2x bridge + help [command] display help for command +``` \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index 1338bc7..96bbca0 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,7 +4,7 @@ import {Command, Option} from 'commander' export const program = new Command() -const can2x = program.name('can2x') +const can2x = program.name('can2x').description('can2x is a simple utility for connecting a can bus unidirectional with another can bus over the network using common web protocols, such as HTTP, MQTT, Socket.IO, and WebSockets.') const bridge = can2x.command('bridge').description('manages a can2x bridge')