rayelliott
/
sampler-fork
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

README draft added

This commit is contained in:
Alexander Lukyanchikov 2019-04-20 00:30:13 -04:00 committed by GitHub
parent 892f2322d2
commit 47293b834d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -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