Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberbit authored Jun 2, 2024
1 parent 53ff505 commit c38786c
Showing 1 changed file with 10 additions and 22 deletions.
32 changes: 10 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,16 @@ Tired of creating complex logic to monitor inventory or production? Want somethi
![image](https://github.com/cyberbit/telem/assets/7350183/22e0862b-a56e-4ec5-ac9d-956c7aa075bb)

## Requirements
- ComputerCraft (Tweaked and Restitched also supported)
- CC: Tweaked recommended, CC: Restitched also supported
- `http` access for installer and certain adapters

> **Note:** These docs are being actively written so please excuse my dust! If you have questions, post them [in this discussion](https://github.com/cyberbit/telem/discussions/12).
## Install
This runs the installer. You have a choice to install minified, packaged, and source versions.
```
wget run https://pinestore.cc/d/14
```

## Usage
### Please visit [telem.cc](https://telem.cc) for full documentation.
### Please visit [telem.cyberbit.dev](https://telem.cyberbit.dev) for full documentation.
```lua
local telem = require 'telem'

Expand All @@ -46,26 +43,17 @@ parallel.waitForAny(
```

## Input Adapters
* Hello World (testing)
* Item Storage
* Fluid Storage
* Refined Storage (RS Bridge)
* ME Storage (ME Bridge)
* Mekanism Fission Reactor
* Mekanism Fusion Reactor
* Mekanism Induction Matrix
* Mekanism Industrial Turbine
* Item and Fluid Storage
* Modded Storage (AE2, Refined Storage)
* Modded Machines (Mekanism)
* Custom Inputs
* **Secure Modems ✨**
* Secure Modem
* _More to come!_

## Output Adapters
* Hello World (testing)
* Grafana* (Grafana Cloud or self-hosted)
* Basalt labels
* Basalt labels and graphs
* Plotter charts
* Custom Outputs
* **Secure Modems ✨**
* Secure Modem
* Grafana (advanced)
* _More to come!_

*You will need to set up a free account on Grafana Cloud or provision a self-hosted Grafana + InfluxDB + Telegraf instance to use the Grafana output. A more detailed guide for Grafana is planned for the future.

0 comments on commit c38786c

Please sign in to comment.