summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2017-12-27 13:59:34 -0500
committerstreetturtle <streetturtle@gmail.com>2017-12-27 13:59:34 -0500
commitd91be91e00ae8f08b974a19a483df804a2ce5cf6 (patch)
treeaa5cbf206db357de8bb883f73624d88a7551fd95
parent7a1a5aff379b86a9d86f4bc809a28b2fb1f62e43 (diff)
update readme
-rw-r--r--translate-widget/README.MD16
1 files changed, 16 insertions, 0 deletions
diff --git a/translate-widget/README.MD b/translate-widget/README.MD
index 87d21c0..230168e 100644
--- a/translate-widget/README.MD
+++ b/translate-widget/README.MD
@@ -1 +1,17 @@
in progress...
+
+# Translate Widget
+
+This widget is based on the [Yandex.Translate API](https://tech.yandex.com/translate/).
+
+## Installation
+
+1. Get an [https://translate.yandex.com/developers/keys](API key)
+1.
+
+
+## Controls
+
+ - <kbd>Mod4</kbd> + <kbd>c</kbd> - opens a translate prompt;
+ - left click on the popup widget - copies the translation to the clipboard and closes widget;
+ - right click on the popup widget - copies text to translate to the clipboard and closes widget. \ No newline at end of file