Merge branch 'master' of github.com:chmln/handlr

README.md

@@ -2,28 +2,75 @@
 
 Manage your default applications with ease using `handlr`!
 
-### Features
+## Features
 
 - Set default handler by extension or mime-type
-- Open path/url with default handler (like xdg-open)
+- Intelligent mime type detection from files based on extension and content
+- Mime-type validation against a massive database
 - List default associations
-- Automatically removes invalid/wrong `.desktop` entries
-- Simply a great command-line experience
+- Automatically removes invalid/wrong `.desktop` entries from `mimeapps.list`
+- Helper commands like `launch`, `get --json` for your scripting needs
+- Unnecessarily fast (written in Rust)
+- Single compiled binary with no dependencies
 
-### Compared to `xdg-open` and `xdg-mime`:
+## Usage
+
+```sh
+# Open a file/URL
+handlr open ~/.dotfiles/pacman/packages.txt
+handlr open https://google.ca
+
+# Set default handler for png files
+handlr set .png feh.desktop
+
+# Set default handler based on mime
+handlr set application/pdf evince.desktop
+
+# List default apps
+handlr list
+
+# Get the handler for a mime/extension
+$ handlr get .png
+feh.desktop
+
+# Launch a handler with given path/URL
+handlr launch x-scheme-handler/https -- https://google.ca
+```
+
+## Compared to `xdg-utils`
+- Far easier to use with simple commands like `get`, `set`, `list`
 - Can operate on extensions, **no need to look up or remember mime types**
   - useful for common tasks like setting a handler for png/docx/etc files
 - Superb autocomplete (currently just fish), including mimes, extensions, and `.desktop` files
 - Optional json output for commands like `get`
 
-
-### Screenshots
+## Screenshots
 
 <table><tr><td>
-<img src=https://user-images.githubusercontent.com/11352152/82114001-f1889400-9727-11ea-8792-801041acd3f3.png width=500>
+<img src=https://user-images.githubusercontent.com/11352152/82159698-2434a880-985e-11ea-95c7-a07694ea9691.png width=500>
 </td><td>
-<img width=450 src=https://user-images.githubusercontent.com/11352152/82113897-45df4400-9727-11ea-8f9b-ec0973178b9c.png>
+<img width=450 src=https://user-images.githubusercontent.com/11352152/82159699-2434a880-985e-11ea-9493-c21773093c38.png>
 </td></tr></table>
 
-### Attr
+## Installation
+
+While packages for distributions are pending,
+
+1. Download the latest [release binary](https://github.com/chmln/handlr/releases) and put it somewhere in `$PATH`
+2. Download completions:
+```sh
+curl https://raw.githubusercontent.com/chmln/handlr/master/completions/handlr.fish --create-dirs -o ~/.config/fish/completions/handlr.fish
+```
+
+---
+
+Alternatively, you can install with `cargo`:
+
+```sh
+cargo install handlr
+```
+
+## Attribution
 Icons made by <a href="https://www.flaticon.com/authors/eucalyp" title="Eucalyp">Eucalyp</a> from <a href="https://www.flaticon.com/" title="Flaticon"> www.flaticon.com</a>
+
+Cover photo by [creativebloq.com](https://creativebloq.com)