Skip to content

Commit

Permalink
toc
Browse files Browse the repository at this point in the history
  • Loading branch information
milesstoetzner committed Sep 21, 2023
1 parent 15039ec commit 07ec7bf
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@

`can2x` is a simple utility for connecting a CAN bus bidirectional with one or multiple CAN busses over the network using common web protocols, such as HTTP, MQTT, Socket.IO, and WebSockets.

## Table of Contents

- [Overview](#overview)
- [Example](#example)
- [Installation](#installation)
- [Requirements](#requirements)
- [Commands](#commands)
- [bridge start](#command-bridge-start)
- [bus start](#command-bus-start)
- [vcan check](#command-vcan-check)
- [vcan start](#command-vcan-start)
- [vcan stop](#command-vcan-stop)
- [CAN Message](#can-message)
- [Limitations](#limitations)
- [Similar Projects](#similar-projects)
- [Dependencies](#dependencies)
- [Notes](#notes)
- [Acknowledgements](#acknowledgements)

## Overview

`can2x` supports various sources and targets when bridging CAN messages.
Expand Down Expand Up @@ -64,7 +83,6 @@ On the target host, we can observe the CAN message.
can2x 01A [8] 11 22 33 44 AA BB CC DD
```


## Installation

Install `can2x` system-wide using `npm`.
Expand Down

0 comments on commit 07ec7bf

Please sign in to comment.