diff --git a/README.md b/README.md index 7e1cfbf..ee756f2 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ - [Overview](#overview) - [Nodes](#nodes) +- [Usage](#usage) - [Dependencies](#dependencies) - [Installation](#installation) - [License](#license) @@ -26,6 +27,18 @@ This mod adds nodes to control the flow of digiline messages in various ways, an - **Splitter** - splits messages into two branches, and stops messages going between the branches. - **Tri-Splitter** - same as Splitter, but splits into three branches. +## Usage + +Digicontrol nodes are designed to be as simple to use as possible. The Diode, Splitter, and Tri-Splitter are similar to mesecons logic gates; they work without any setup. + +The Filter can be right-clicked to set the channel it will filter. If left blank it will allow all messages to pass through, if a channel is specified, it will only let messages on that channel through, blocking all others. + +![Filter Formspec](images/filter_formspec.png?raw=true "Filter Formspec") + +The Limiter can also be right-clicked to set the rate at which messages can pass through. A value of 1 or higher will allow that number of messages to pass through per second, blocking further messages. A value of 0 blocks all messages, and a value of -1 allows an infinite number of messages. + +![Limiter Formspec](images/limiter_formspec.png?raw=true "Limiter Formspec") + ## Dependencies **Required** diff --git a/images/filter_formspec.png b/images/filter_formspec.png new file mode 100644 index 0000000..3caf17f Binary files /dev/null and b/images/filter_formspec.png differ diff --git a/images/limiter_formspec.png b/images/limiter_formspec.png new file mode 100644 index 0000000..61d28b8 Binary files /dev/null and b/images/limiter_formspec.png differ diff --git a/images/overview.png b/images/overview.png index a4f4791..8cbf440 100644 Binary files a/images/overview.png and b/images/overview.png differ diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..86be5a4 Binary files /dev/null and b/screenshot.png differ