Skip to content

Commit

Permalink
Specify the license and update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ngmy committed Apr 25, 2015
1 parent 7d87c1e commit 1c57918
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 12 deletions.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2013 Yuta Nagamiya

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,29 @@ The **Vim RuboCop** plugin runs [RuboCop](https://github.com/bbatsov/rubocop) an

## Requirements

- Please note that the current version of the Vim RuboCop plugin requires RuboCop 0.12.0 or later.
Please note that the current version of the Vim RuboCop plugin requires RuboCop 0.12.0 or later.

## Installation

- Obtain a copy of this plugin and place `rubocop.vim` in your Vim plugin.
Obtain a copy of this plugin and place `rubocop.vim` in your Vim plugin directory.

## Usage

- You can use the `:RuboCop` command to run RuboCop and display the results.
You can use the `:RuboCop` command to run RuboCop and display the results.

- To run with specified config file add this line to your `.vimrc` file:
You can also use the `:RuboCop` command together with options. For example, `:RuboCop -l`, `:RuboCop -a` and so on.

```viml
let g:vimrubocop_config = '/path/to/rubocop.yml'
```
### Configuration File

### Keyboard Shortcuts ###
Credit for Shortcuts: [Ack.vim](https://github.com/mileszs/ack.vim)
To run with the specified configuration file, add the following line to your `.vimrc` file:

```viml
let g:vimrubocop_config = '/path/to/rubocop.yml'
```

### Keyboard Shortcuts

Credit for Shortcuts: [Ack.vim](https://github.com/mileszs/ack.vim)

In the quickfix window, you can use:

Expand All @@ -46,3 +51,7 @@ your `.vimrc`:
let g:vimrubocop_keymap = 0
nmap <Leader>r :RuboCop<CR>
```

## License

The Vim RuboCop plugin is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
8 changes: 5 additions & 3 deletions plugin/rubocop.vim
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
" The "Vim RuboCop" plugin runs RuboCop and displays the results in Vim.
"
" Author: ngmy
" URL: https://github.com/ngmy/vim-rubocop
" Version: 0.3
" Author: Yuta Nagamiya
" URL: https://github.com/ngmy/vim-rubocop
" Version: 0.4
" Copyright: Copyright (c) 2013 Yuta Nagamiya
" License: MIT
" ----------------------------------------------------------------------------

if exists('g:loaded_vimrubocop') || &cp
Expand Down

0 comments on commit 1c57918

Please sign in to comment.