Add README

1 files changed, 40 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3270557
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# tmux-fzf-url
+
+`tmux-fzf-url` is a tmux plugin for opening urls on screen quickly without mouse.
+
+![screenshot](screenshot.gif)
+
+## Install
+
+Make sure you have [`fzf`](https://github.com/junegunn/fzf) installed.
+
+### [tmp](https://github.com/tmux-plugins/tpm) (Recommend)
+
+Just add this line to your tmux config file:
+
+``` tmux
+    set -g @plugin 'wfxr/tmux-fzf-url'
+```
+
+### Manually
+
+Clone this repo somewhere and source `fzf-url.tmux` at the config file.
+
+## Options
+
+The default key-binding is `u`(of course prefix hit is needed), it can be modified by
+setting value to `@fzf-url-bind` at the tmux config like this:
+
+``` tmux
+    set -g @fzf-url-bind 'x'
+```
+
+## Tips
+
+- Use `tab` to mark multiple urls and open them at once.
+- Hit `ctrl-r` to toggle selection.
+- The tmux theme of screenshot is [tmux-power](https://github.com/wfxr/tmux-power)(currently no `README` :sweat_smile:, will add sometime).
+
+## License
+
+[MIT](LICENSE.txt)