Skip to content

Commit

Permalink
Clean up README
Browse files Browse the repository at this point in the history
  • Loading branch information
simeg committed Aug 16, 2018
1 parent 4d89fb4 commit 428e8f9
Showing 1 changed file with 29 additions and 27 deletions.
56 changes: 29 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,39 @@
Vimari - Keyboard Shortcuts extension for Safari
================================================
# Vimari - Keyboard Shortcuts extension for Safari

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.
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.
Vimari attempts to provide a lightweight port of vimium to Safari, taking the
best components of vimium and adapting them to Safari.

### Releases
- [Version 2.0.0](docs/safari_12.md) (Safari v12)
- [Version 1.13](https://github.com/guyht/vimari/releases/tag/v1.13)
- [Version 1.12](https://github.com/guyht/vimari/releases/tag/v1.12)
- [Version 1.11](https://github.com/guyht/vimari/releases/tag/v1.11)
- [Version 1.10](https://github.com/guyht/vimari/releases/tag/v1.10)
- [Version 1.9](https://github.com/guyht/vimari/releases/tag/v1.9)
![Screenshot](assets/screenshot.png)

__Installation Instructions__
## Releases

Click the download link below and double-click the file to get the
latest version of vimari:
### Safari 12
- [v2.0.0](docs/safari_12.md)

https://github.com/guyht/vimari/releases/latest
### Safari 11 and below
- [v1.13](https://github.com/guyht/vimari/releases/tag/v1.13)
- [v1.12](https://github.com/guyht/vimari/releases/tag/v1.12)
- [v1.11](https://github.com/guyht/vimari/releases/tag/v1.11)
- [v1.10](https://github.com/guyht/vimari/releases/tag/v1.10)
- [v1.9](https://github.com/guyht/vimari/releases/tag/v1.9)

## Installation

Screenshot
-----------
### Safari 12

![Screenshot](assets/screenshot.png)
Read [this guide](docs/safari_12.md).

### Safari 11

Usage
-----
[Download the latest
version](https://github.com/guyht/vimari/releases/tag/v1.13) and double-click
the file.

## Usage

### Settings
**Command Prefix** - Modifier key to hold down with your action key. If
Expand All @@ -40,7 +43,7 @@ setting).
**Excluded URLs** - Comma separated list of website URLs you don't want
to use vimari with. To exclude GitHub for example, provide the value
`github.com` or `http://github.com`. It's smart and should handle all
possible domain cases though.
possible domain cases.

**Link Hint Characters** - Allowed characters to be used when generating
link shortcuts.
Expand Down Expand Up @@ -77,7 +80,6 @@ settings of the extension. You can find them in
X Close current tab and go to right tab
t Open new tab

License
-------
Copyright (c) 2011 Guy Halford-Thompson. See MIT-LICENSE.txt for
details.
## License

Copyright (C) 2011 Guy Halford-Thompson. See [LICENSE](LICENSE) for details.

0 comments on commit 428e8f9

Please sign in to comment.