From 87e2b1e186b60d6197687fbd30834540ed014753 Mon Sep 17 00:00:00 2001
From: "James N. V. Cash" <james.nvc@gmail.com>
Date: Mon, 16 Oct 2017 19:57:30 -0400
Subject: [PATCH] Show the possible values of the OS type enum in README

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 6ef6e4ee..3cdf9123 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,15 @@ The extension provides the following methods on the `HostOS` singleton:
 > Sets the type of the host OS, overriding any previous value. The type is then
 > stored in EEPROM for persistence.
 
+## Host OS Values
+
+The OS type (i.e. the return type of `.os()` and the arguments to `.os(type)`) will be one of the following:
+
+   - `kaleidoscope::hostos::LINUX`
+   - `kaleidoscope::hostos::OSX`
+   - `kaleidoscope::hostos::WINDOWS`
+   - `kaleidoscope::hostos::OTHER`
+
 ## Dependencies
 
 * [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings)