From 47293b834d79ee829cf963b0e216f1ab750af011 Mon Sep 17 00:00:00 2001 From: Alexander Lukyanchikov Date: Sat, 20 Apr 2019 00:30:13 -0400 Subject: [PATCH] README draft added --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dbf6494..e00754f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ -## Sampler. Visualization for any shell command. +# Sampler. Visualization for any shell command. + +Sampler is a tool for shell commands execution, visualization and alerting. Configured with a simple YAML file. ![sampler](https://user-images.githubusercontent.com/6069066/56404396-70b14d00-6234-11e9-93cd-54461bf40c96.gif) + +## Installation + +### macOS +... +### Linux +... +### Windows +... +## Usage +Using Sampler is basically a three-step process: +- Define your configuration in a YAML file +- Run `sampler -c config.yml` +- Adjust components size and location, if needed + +## Configuration + +Links to the sections below + +### Runchart +... +### Sparkline +... +### Barchart +... +### Gauge +... +### Textbox +... +### Asciibox +... +### Triggers +Perform conditional actions, like visual/sound alerts or a shell command + +### Interactive shell +Allows efficient database polling, remote server access, etc + +### Variables +Extract variables or repeated patterns into YAML variables or command line flags + + + +