update documentation

Author: blahgeek

.travis.yml

@@ -1,4 +1,5 @@
 dist: trusty
+sudo: required
 addons:
   apt:
     packages:

config/default.toml

@@ -19,6 +19,8 @@ extra_plugin_directories = [
     history_file_salt = "Minions-Salt"
 
 # list of search engines
+# Each site must have `name` and `address` defined
+# and optionally `suggestion_url` for suggestions, which follows the OpenSearch standard
 [search_engine]
     [[search_engine.sites]]
     name = "Google"
@@ -36,12 +38,16 @@ extra_plugin_directories = [
     address = "https://en.wikipedia.org/wiki/Special:Search?search=%s"
     suggestion_url = "https://en.wikipedia.org/w/api.php?action=opensearch&search=%s"
 
+# Linux desktop entries (Applications)
 [linux_desktop_entry]
-directories = [
-    "/usr/local/share/applications/",
-    "/usr/share/applications/",
-]
+# Directories to find all .desktop files
+    directories = [
+        "/usr/local/share/applications/",
+        "/usr/share/applications/",
+    ]
 
+# File Browser
+# Each entry must include a `name` and a valid `path` (can be directory or file)
 [file_browser]
     [[file_browser.entries]]
     name = "Home Directory"
@@ -50,6 +56,9 @@ directories = [
     name = "Root Directory"
     path = "/"
 
+
 [clipboard_history]
-max_entries = 64
-ignore_single_byte = true
+    # Max number of recent entries to record in history
+    max_entries = 64
+    # Whether to ignore entries with only single byte (useful if you use vim and press "x" a lot)
+    ignore_single_byte = true

doc/quickstart.md

@@ -16,6 +16,7 @@ Hit `<ctrl>space`, the Minions would show up.
 ![](../images/ui-start.png)
 
 Start typing few characters (in the following image, `p`) and filtered actions would show up. The filter text would be reset to empty if you dont't type for a short period of time.
+Note that the filtering engine is **adaptive**, which means that after you type "g" and select "Google" for several times, that item would gradually be the default when you type "g". (And don't worry, to protect your privacy, the content (filter text and item title) of your history would *NOT* be stored in disk. See [the code](../src/mcore/matcher.rs) for more details.)
 
 ![](../images/ui-filtering.png)
 

doc/screencast-todo.md

@@ -0,0 +1,21 @@
+---
+@Author: BlahGeek
+@Date: 2017-08-11
+@Last modified by: BlahGeek
+@Last modified time: 2017-08-11
+---
+
+# Intro to Minions!
+
+- Launch application named "SMPlayer"
+- Simple calculation: what's the answer to universe, life and everything?
+- Find out how to program "hello world" using duckduckgo
+- Lookup *电脑* in dictionary using _QuickSend_
+- Access clipboard history
+    - Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+    - Aliena dixit in physicis nec ea ipsa, quae tibi probarentur;
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+- Search my IP address using Google
+    - Get my IP address
+    - _QuickSend_ to Google
+- And so much more...