From bd6dbdabac1d78f7f4a53fd5545fa29d198cc6ad Mon Sep 17 00:00:00 2001
From: Evan Pratten <ewpratten@gmail.com>
Date: Sun, 23 Jan 2022 14:15:57 -0500
Subject: [PATCH] Add the README

---
 README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
 icon.png  |  0
 2 files changed, 50 insertions(+), 5 deletions(-)
 create mode 100644 icon.png

diff --git a/README.md b/README.md
index 23c6ad3..250e54c 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,64 @@
-# tabset
+# TABSET
 [![Crates.io](https://img.shields.io/crates/v/tabset)](https://crates.io/crates/tabset) 
-[![Docs.rs](https://docs.rs/tabset/badge.svg)](https://docs.rs/tabset) 
 [![Build](https://github.com/Ewpratten/tabset/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/tabset/actions/workflows/build.yml)
 [![Clippy](https://github.com/Ewpratten/tabset/actions/workflows/clippy.yml/badge.svg)](https://github.com/Ewpratten/tabset/actions/workflows/clippy.yml)
 [![Audit](https://github.com/Ewpratten/tabset/actions/workflows/audit.yml/badge.svg)](https://github.com/Ewpratten/tabset/actions/workflows/audit.yml)
 
 
-repo description
+`tabset` is a Linux command-line tool for configuring your drawing tablets. 
+
+The tool is based around the concept of configuration scripts, and follows a super simple, yet extensible configuration system. Each device you might own gets its own directory, and inside some simple metadata is stored along with a list of shell scripts you can use to set various `xsetwacom` options.
 
 ## Installation
 
-This crate can be installed via `cargo` with:
+[![Get Appimage](https://raw.githubusercontent.com/srevinsaju/get-appimage/master/static/badges/get-appimage-branding-blue.png)](https://github.com/Ewpratten/tabset/releases/latest)
+
+This crate can also be installed via `cargo` with:
 
 ```sh
 cargo install tabset
 ```
 
-## Configuration
\ No newline at end of file
+## Configuration
+
+Configuration files are stored in `~/.config/tabset/`. These files are simply sorted by directory. Here is a listing of my personal configs:
+
+```shell
+# ewpratten@ewpratten-desktop ~/.config/tabset $ tree
+.
+└── devices
+    └── huion-kamvas-13
+        ├── name
+        ├── peripherals
+        └── profiles
+            ├── blender.sh
+            ├── default.sh -> blender.sh
+            └── disabled.sh
+
+3 directories, 5 files
+```
+
+The `name` and `peripherals` files must exist for each device. `name` is mostly un-used at the moment, but should contain a friendly name for your device. `peripherals` is a list of strings that `tabset` will search for in the output of `xsetwacom --list` if you run the `tabset check <device>` command.
+
+Each of the profile scripts just contain whatever configuration commands you want. You can see my blender one [in the example config directory](./example_configs/devices/huion-kamvas-13/profiles/blender.sh).
+
+### Usage
+
+```text
+tabset 0.1.0
+Evan Pratten <ewpratten@gmail.com>
+A Linux drawing tablet configuration tool
+
+USAGE:
+    tabset <SUBCOMMAND>
+
+FLAGS:
+    -h, --help       Prints help information
+    -V, --version    Prints version information
+
+SUBCOMMANDS:
+    check      Check if a specific tablet is connected. Prints message and returns status code
+    help       Prints this message or the help of the given subcommand(s)
+    list       List all configured devices and their profiles
+    profile    Set a specific tablet to use a specific profile
+```
diff --git a/icon.png b/icon.png
new file mode 100644
index 0000000..e69de29