summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..65c0616
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# wttrin.el
+
+Emacs frontend for weather web service [wttr.in].
+
+wttrin.el provides the weather information from wttr.in based on your
+query condition.
+
+## Usage
+
+Set variable `wttrin-query`:
+
+```elisp
+(defvar wttrin-query "Taipei")
+```
+
+Run `M-x wttrin-exec` to get the information:
+
+![screenshot]
+
+## LICENSE
+
+MIT
+
+[wttr.in]: http://wttr.in/
+[screenshot]: wttrin.png \ No newline at end of file