First public version.

1 files changed, 53 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..01fa119
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# Pebble My Data App
+
+Pebble watches application to show only your own data, prepared on your own server.
+Sources available on [github](https://github.com/bahbka/pebble-my-data).
+Inspired by [Pebble Cards](http://keanulee.com/pebblecards).
+
+# Features
+
+* Fetch JSON from custom URL, specified in settings
+* No companion app required, using PebbleKit JS
+* Force update with select button
+* Scrollable data area
+* Custom update interval, specified in JSON
+* Vibrate on update if specified in JSON
+* Change text font from JSON
+* Black/white theme switched from JSON
+* Vibrate on bluetooth connection loss
+* Watches battery charge status
+
+# JSON
+
+JSON output example (some fields are optional):
+
+    {
+      "content": "Hello\\nWorld!",
+      "refresh": 300,
+      "vibrate": 0,
+      "font": 4,
+      "theme": 0
+    }
+
+# Vibrate
+
+0 - Don't vibrate
+1 - Short vibrate
+2 - Double vibrate
+3 - Long vibrate
+
+# Fonts
+
+1 - FONT_KEY_GOTHIC_14
+2 - FONT_KEY_GOTHIC_14_BOLD
+3 - FONT_KEY_GOTHIC_18
+4 - FONT_KEY_GOTHIC_18_BOLD
+5 - FONT_KEY_GOTHIC_24
+6 - FONT_KEY_GOTHIC_24_BOLD
+7 - FONT_KEY_GOTHIC_28
+8 - FONT_KEY_GOTHIC_28_BOLD
+
+# Theme
+
+0 - Black
+1 - White