Merge pull request #198 from televator-apps/updated-readme

Update README v2.1

Author: nbelzer

DEVELOPERS.md

@@ -0,0 +1,36 @@
+# Developers
+
+## Setup
+
+### Local setup
+
+1. Clone the repository:
+   ```bash
+   git clone [email protected]:televator-apps/vimari.git
+   ```
+2. Open `Vimari.xcodeproj` with Xcode.
+3. [Set your signing team](https://help.apple.com/xcode/mac/current/#/dev23aab79b4) for both targets (Vimari and Vimari Extension).
+4. Run the project (<kbd>⌘</kbd>+<kbd>R</kbd>).
+
+You might have to reload the website you had open for the changes to take effect. Also check your configuration file as it currently does not get upgraded automatically.
+
+### Linting & Formatting
+
+Code linting and formatting will be implemented in [#193](https://github.com/televator-apps/vimari/pull/193).
+
+## Contributing
+
+If you'd like to contribute to the development of Vimari you can help us out through several means:
+
+1. Create bug reports for issues you encounter, or look trough existing bug reports and try to reproduce their problems.
+2. Try out the latest beta version (if there is one) and report issues back to us.
+3. Contribute ideas, if you'd like something to be added to Vimari you can create an issue describing exactly what you have in mind. Together we can help form the idea and get it into Vimari.
+4. Contribute code, if you find a bug or issue that you think you can help us solve you are more than welcome to do so.
+
+### Contributing Code
+
+If you want to contribute to Vimari through coding you have to start by selecting an issue to work on. If you'd like to contribute something new, make an issue first to discuss the idea.
+
+You can fork the Vimari source code and make the changes to implement your feature or solve a bug. Once finished you can create a pull request back into the Vimari repository where it can be reviewed.
+
+After a successful review your code will be merged with the master branch and released to Vimari users in the next release. Pretty cool!

README.md

@@ -1,21 +1,25 @@
-# Vimari - Keyboard Shortcuts extension for Safari
+<img align="left" width=160 style="padding: 10px" src="assets/logo.svg"></img>
 
-[![Actions Status](https://github.com/danielcompton/vimari/workflows/Node%20CI/badge.svg)](https://github.com/danielcompton/vimari/actions)
+## Vimari
+_Keyboard Shortcuts extension for Safari_
 
 [![Download on the Mac App Store](assets/Download_on_the_Mac_App_Store_Badge_US.svg)](https://apps.apple.com/us/app/vimari/id1480933944?ls=1&mt=12)
 
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/televator-apps/vimari)
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/televator-apps/vimari?include_prereleases&label=pre%20release)
+
 Vimari is a Safari extension that provides keyboard based navigation.
 The code is heavily based on [vimium](https://github.com/philc/vimium), a
 Chrome extension that provides much more extensive features.
 
 Vimari attempts to provide a lightweight port of vimium to Safari, taking the
 best components of vimium and adapting them to Safari.
 
-![Screenshot](assets/screenshot.png)
+<img src="assets/screenshot.png"></img>
 
 ## Releases
 
-### Safari 12 and 13
+### Safari 12 and above
 
 [![Download on the Mac App Store](assets/Download_on_the_Mac_App_Store_Badge_US.svg)](https://apps.apple.com/us/app/vimari/id1480933944?ls=1&mt=12)
 
@@ -28,13 +32,13 @@ best components of vimium and adapting them to Safari.
 
 ## Installation
 
-### Safari 12 and 13 (macOS Mojave and Catalina)
+### Safari 12 and above (macOS Mojave or above)
 
 #### Mac App Store
 
 1. [Download Vimari](https://apps.apple.com/us/app/vimari/id1480933944?ls=1&mt=12) for free from the Mac App Store
 2. Launch Vimari.app
-3. Click "Open in Safari Extensions Preferences...", Safari's Extension Preferences should open
+3. Click "Open in Safari Extensions Preferences", Safari's Extension Preferences should open
 4. Make sure that the checkbox for the Vimari extension is ticked
 5. Go back to Vimari.app and press the reload button to check the status of the app. If it says "Enabled" then it is ready.
 6. You may need to relaunch Safari for the extension to work
@@ -60,7 +64,7 @@ the file.
 ## Usage
 
 ### Settings
-**Command Prefix** - Modifier key to hold down with your action key. If
+**Modifier** - Modifier key to hold down with your action key. If
 you leave it blank you don't need to hold down anything (default
 setting).
 
@@ -77,10 +81,28 @@ for HTML elements having cursor style set to "pointer".
 
 **Scroll Size** - How much each scroll will move on the page.
 
-**Transparent Bindings** - Instead of fully isolating all keybindings in normal mode, the transparent bindings setting (when enabled)  allows you to use all non-Vimari-bound keys to interact with the web page as if you were in insert mode.
+`Vimari v2.1+`
+
+**Smooth Scroll** - Scroll smoothly through the page.
+
+ **Normal vs Insert mode** - Isolate website keybindings from the
+Vimari keybindings. In normal mode you can use the Vimari keybindings
+while in insert mode you can use the websites own keybindings.
+
+**Transparent Bindings** - Full keybinding isolation might not
+be your style, instead the transparent bindings setting (when enabled)
+allows you to use all **non-Vimari-bound** keys to interact with the web
+page as if you were in insert mode.
+
+**Multiple Bindings** - You can bind multiple keybindings to a Vimari
+action. This is done by specifying an array of bindings in the 
+configuration file, like so: `"goToPageTop": ["g g", "shift+k"]`.
+
 
 ### Keyboard Bindings
 
+These bindings are the ones set by default, however you are able to change them in the settings.
+
 #### In-page navigation
     f       Toggle links
     F       Toggle links (open link in new tab)
@@ -92,6 +114,7 @@ for HTML elements having cursor style set to "pointer".
     d       Scroll down half page
     g g     Go to top of page
     G       Go to bottom of page
+    g i     Go to first input
 
 #### Page/Tab navigation
     H       History back
@@ -102,6 +125,23 @@ for HTML elements having cursor style set to "pointer".
     x       Close current tab
     t       Open new tab
 
+`Vimari v2.1+`
+
+#### Vimari Modes
+    i       Enter insert mode
+    ESC     Enter normal mode
+    CTRL+[  Enter normal mode
+    
+### Tips & Tricks
+
+Vimari is built as a Safari Extension, this poses some limits on what is possible through the extension. However default Safari shortcuts can help you keep your hands at the keyboard. Some helpful ones are listed here:
+
+- **Focus URL Bar** <kbd>⌘</kbd><kbd>l</kbd> - This is a feature not available in Vimari, it is also helpful where extensions are not loaded (for example on `topsites://`). By focusing the URL Bar you can go to a website where the extension is loaded.
+
+- **Reader mode** <kbd>⇧</kbd><kbd>⌘</kbd><kbd>R</kbd> - Currently Vimari does not support entering Reader mode (due to API limitations), also navigation inside reader mode (for example using <kbd>j</kbd> or <kbd>k</kbd>) is not supported.
+
+- **Re-open last closed tab** <kbd>⇧</kbd><kbd>⌘</kbd><kbd>T</kbd> - Allows you to reopen a recently closed tab.
+
 ## License
 
 Copyright (C) 2011 Guy Halford-Thompson. See [LICENSE](LICENSE) for details.