The vrome's intro from bgoldsworthy

##Vrome - The most cool, featured Vim keybindings extension for Chrome you could found!

Vrome is a Vim keybindings extension for chrome, It is used to give you a more efficient browsing. Proudly recommend it to you!

It conver features about Navigation, Tab manipulation, Marks, Hint Mode, Scrolling, Zoom, History, Bookmark, Search, Shorten URL, InsertMode, External editor support, build your own keybindings...

NOTE Chrome does not allow extensions to run on Chrome Webstore, Setting page and New Tab page!

NOTE Vrome is a open source project. It's Reliable. We won't use your personal information! All permissions required are used for features. You could check the source code here: http://github.com/jinzhu/vrome

NOTE You need to refresh all tabs to enable all Vrome features after install. Tip: use "<C-r>" (Control + R) to refresh one tab, then try Vrome command "R" to refresh all.

NOTE Vrome would only works in incognito mode and file URLs after you allow it. You could allow it in chrome://extensions page.

NOTE Type <F1> to show help document.

Install

RECOMMEND: Install the latest stable Vrome from Chrome Web Store. then it would be automatically updated when a new version is available!

You can also install it from source. please refer Develop Guide in our WIKI

Features

Vrome is a vim keybindings extension for Chrome, inspiration from the Vim text editor and Vimperator for Firefox. So it works almost like Vim and Vimperator.

But there are some additions to make Vrome sweet! hope there are some surprises for you! ;)

Lots of features can't list all them here. But if you want to be more effective with Vrome, you do need to check them out! The Features List

Go ahead and enjoy!

Custom

After install Vrome. you could customize the keybindings, disable sites, external editor and other settings in Vrome's option page.

Click the Vrome icon on the right of main Google Chrome toolbar after install
In popup page, click "Option" to navigate to Vrome's option page
You can add your config to the textarea named .Vromerc. Vrome even support remotely config, you just need to input the URL to the Online .Vromerc field. It would be useful for those want to share config between multiple computers like me. (I have uploaded my very own one config to github)
Checkout the example configure for available options

ChangeLog

https://github.com/jinzhu/vrome/blob/master/ChangeLog.mkd

Contributing

Reporting an Issue

Vrome uses GitHub Issue Tracking to track issues
If you’ve found a bug in Vrome, this is the place to start. (A free github account is required to submit issues)

Bugfix or Implement new features

Checkout bugs or feature requests on GitHub Issue Tracking
If you found some interesting things want to work on, fork vrome and start hacking! When you're done, send a pull request on Github
Checkout our Develop Guide for start

Contributing to Documentation

Find errors in README? Fix it according Bugfix way or send an email to let me know ([email protected])
Correct our WIKI or Add more useful things

Make more people know and love Vrome

Tell Vrome to your friends with Twitter, Facebook, Google+...
Rate Vrome in Chrome Web Store
Write blog, tutorial or even record videos. Be sure add your links to our WIKI ;)

Thanks!

Author

Jinzhu

bgoldsworthy / vrome Goto Github PK

vrome's Introduction