README draft added
This commit is contained in:
parent
892f2322d2
commit
47293b834d
47
README.md
47
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)
|
![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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue