From 0a6f79d9165444f465f851d6d50460fb488a899f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miles=20St=C3=B6tzner?= <miles@stoetzner.de>
Date: Mon, 4 Sep 2023 01:31:23 +0200
Subject: [PATCH] description

---
 README.md    | 29 +++++++++++++++++++++++++++++
 src/index.ts |  2 +-
 2 files changed, 30 insertions(+), 1 deletion(-)

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')