Updated readme

anoriqq · Aug 13, 2019 · b040253 · b040253
1 parent 156d23f
commit b040253
Show file tree

Hide file tree

Showing 21 changed files with 258 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Oliver Schwendener
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,237 @@
+![logo](./assets/readme-header.png)
+
+# ueli
+
+This is a keystroke launcher for Windows and macOS.
+
+![example-image](./assets/example-image.png)
+
+## Table of contents
+
+* [Installation](#installation)
+* [Features](#features)
+* [Settings](#settings)
+* [Updating](#updating)
+* [Privacy](#privacy)
+* [Known bugs](#known-bugs)
+* [Development](#development)
+* [Alternatives](#alternatives)
+* [License](#license)
+* [Release notes](https://github.com/oliverschwendener/ueli/releases)
+
+## Installation
+
+### Installer / Zip
+
+* Download the latest version [here](https://github.com/oliverschwendener/ueli/releases)
+* Run the installer or unzip
+* Run the application
+
+> Note: because the executables are not signed Windows will probably prevent you from executing the installer or the program itself. You can click "Run anyway" to install/run the program.
+
+### Installing via chocolatey repository
+
+* Open a powershell with administration rights (Right click on your start button and click `Windows PowerShell (Admin)`
+* Type `choco install ueli`
+* Accept the upcoming prompt by entering `y` or run above command with `-y` switch
+* Run the application
+
+## Features
+
+### Application Search
+
+This plugin is searching for applications on your computer. You can specify the folders where your applications are installed and which file extension should be used to recognize an application.
+
+![app-search](./assets/feature-app-search.png)
+
+### Calculator
+
+This Plugin lets you quickly do simple calculations.
+
+![calculator](./assets/feature-calculator.png)
+
+### Commandline
+
+This plugin enables you to quickly execute commandline commands.
+
+![commandline](./assets/feature-commandline.png)
+
+### Currency Converter
+
+This plugin enables you to quickly convert currencies. The latest conversion rates are provided by https://exchangeratesapi.io/.
+
+![currency-converter](./assets/feature-currency-converter.png)
+
+### Email
+
+This plugin enables you to quickly start writing an email by typing in an email address.
+
+![email](./assets/feature-email.png)
+
+### Everything (Windows only)
+
+This feature enables you to use [Everything Search](https://www.voidtools.com) to find files and folders on your local file system.
+
+1. Install "Everything" and the "Everything Command-line interface" from [https://www.voidtools.com/downloads](https://www.voidtools.com/downloads).
+2. Specify the file path to `es.exe` in ueli's settings.
+
+![everything](./assets/feature-everything.png)
+
+### mdfind (macOS only)
+
+This plugin enables you to use the native macOS search to find files and folders on your local file system.
+
+![mdfind](./assets/feature-mdfind.png)
+
+### File Browser
+
+This plugin enables you to browse through your local file system. To start you have to enter a valid absolute filepath.
+
+![file-browser](./assets/feature-file-browser.png)
+
+### Operating System Commands
+
+Operating system commands are simple commands to control your operating system e.g. to shutdown or restart your computer.
+
+![operating-system-commands](./assets/feature-operating-system-commands.png)
+
+### Operating System Settings
+
+This plugin enables you to quickly find operating system settings.
+
+![operating-system-settings](./assets/feature-operating-system-settings.png)
+
+### Shortcuts
+
+This plugin enables you to quickly open files or websites by setting up your own shortcuts.
+
+![shortcuts](./assets/feature-shortcuts.png)
+
+### Simple Folder Search
+
+This plugin enables you to quickly search for files or folders.
+
+![simple-folder-search](./assets/feature-simple-folder-search.png)
+
+### Translation
+
+This plugin enables you to quickly translate words or short sentences. It uses an unofficial [API](https://github.com/imankulov/linguee-api) for [Linguee](https://linguee.de) and may be unstable.
+
+![translation](./assets/feature-translation.png)
+
+### UWP (Windows only)
+
+This plugin enables you to find preinstalled UWP apps.
+
+![uwp](./assets/feature-uwp.png)
+
+### URL
+
+This plugin enables you to quickly open websites by typing in a URL.
+
+![url](./assets/feature-url.png)
+
+### Web Search
+
+This plugin enables you to quickly search the internet with your favorite web search engine by setting up your own web search engines.
+
+![web-search](./assets/feature-web-search.png)
+
+### Workflow
+
+This plugin enables you to quickly execute multiple things at once.
+
+![workflow](./assets/feature-workflow.png)
+
+## Settings
+
+![settings](./assets/settings.png)
+
+To open the settings simply search for "Settings" or press `Ctrl+i` on Windows or `Cmd+,` on macOS. Here you can start configuring the app to your needs by enabling/disabling features or changing the settings.
+
+
+## Updating
+
+The check if any updates are available open the settings. Under "General Settings" you can check if an update is available or not. 
+
+On Windows you can directly update the app. On macOS you have to manually download the newest release and replace the existing app.
+
+## Privacy
+
+For better search results ueli is keeping track of the applications, files and folders you are executing. If you don't want ueli to track your executions simply open the settings and click on the "three-dot" menu on the top right and choose "Clear execution log" and disable the option "Log execution".
+
+## Known bugs
+
+* ([#37](https://github.com/oliverschwendener/ueli/issues/37)) Window starts to move while typing when custom scaling in Windows is set.
+* ([#92](https://github.com/oliverschwendener/ueli/issues/92)) If you see an error that says `spawn powershell.exe ENOENT` check if powershell is installed (should be installed in all recent Versions of Windows by default) and check if powershell is in the PATH variable.
+
+For more check [here](https://github.com/oliverschwendener/ueli/issues).
+
+## Development
+
+### Requirements
+
+* Git
+* Node 12.x.x
+* Yarn
+
+### Setup
+
+```
+$ git clone https://github.com/oliverschwendener/ueli
+$ cd ueli
+$ yarn
+```
+
+### Run
+
+```
+$ yarn bundle
+$ yarn start
+```
+
+> Note: there is also a watch task $ yarn bundle:watch which watches the typescript files and bundles them automatically if there are any changes.
+
+### Debug
+
+For debugging Visual Studio Code is recommended.
+
+1. Go to .vscode folder
+2. Make a copy of launch.example.json and rename it to launch.json
+3. Select one of the preconfigured debug modes and start debugging
+
+### Run tests
+
+```
+$ yarn test
+```
+
+### Package
+
+#### Create portable version
+
+```
+$ yarn package:dir
+```
+
+#### Create installer
+
+```
+$ yarn package
+```
+
+## Alternatives
+
+* [khanhas/ueli](https://github.com/khanhas/ueli)
+* [Launchy](https://www.launchy.net/)
+* [Wox](https://github.com/Wox-launcher/Wox)
+* [Keypirinha](http://keypirinha.com/)
+* [Alfred](https://www.alfredapp.com/)
+* [Hain](https://github.com/hainproject/hain)
+* [Zazu App](http://zazuapp.org/)
+* [Cerebro](https://cerebroapp.com/)
+
+## License
+
+Copyright (c) Oliver Schwendener. All rights reserved.
+Licensed under the [MIT](LICENSE) License.
diff --git a/assets/example-image.png b/assets/example-image.png
diff --git a/assets/feature-app-search.png b/assets/feature-app-search.png
diff --git a/assets/feature-calculator.png b/assets/feature-calculator.png
diff --git a/assets/feature-commandline.png b/assets/feature-commandline.png
diff --git a/assets/feature-currency-converter.png b/assets/feature-currency-converter.png
diff --git a/assets/feature-email.png b/assets/feature-email.png
diff --git a/assets/feature-everything.png b/assets/feature-everything.png
diff --git a/assets/feature-file-browser.png b/assets/feature-file-browser.png
diff --git a/assets/feature-operating-system-commands.png b/assets/feature-operating-system-commands.png
diff --git a/assets/feature-operating-system-settings.png b/assets/feature-operating-system-settings.png
diff --git a/assets/feature-shortcuts.png b/assets/feature-shortcuts.png
diff --git a/assets/feature-simple-folder-search.png b/assets/feature-simple-folder-search.png
diff --git a/assets/feature-translation.png b/assets/feature-translation.png
diff --git a/assets/feature-url.png b/assets/feature-url.png
diff --git a/assets/feature-uwp.png b/assets/feature-uwp.png
diff --git a/assets/feature-web-search.png b/assets/feature-web-search.png
diff --git a/assets/feature-workflow.png b/assets/feature-workflow.png
diff --git a/assets/readme-header.png b/assets/readme-header.png
diff --git a/assets/settings.png b/assets/settings.png