README.md in neobundle-0.1.0 vs README.md in neobundle-0.2.0
- old
+ new
@@ -1,6 +1,6 @@
-# NeoBundle
+# NeoBundle CMD
[NeoBundle](https://github.com/Shougo/neobundle.vim "Shougo/neobundle.vim") command line tools.
## Installation
@@ -52,71 +52,94 @@
The structure of the command line is shown below:
```bash
$ neobundle [--help] [--version]
- [--vim=<path>] [--vimrc=<path>]
+ [--vim=<path>] [--bundlefile=<path>] [--verbose=<level>]
<command>
```
### commands
#### install
-This command will install the Vim plugins by the NeoBundle which is described the `vimrc`.
-It equals the `:NeoBundleInstall` vim command.
+This command will install the Vim plugins by the NeoBundle which is described the bundle file.
+It equals the `:NeoBundleInstall` Vim command.
```bash
$ neobundle install
```
#### clean
This command will delete the Vim plugins which is unused.
-It equals the `:NeoBundleClean!` vim command.
+It equals the `:NeoBundleClean!` Vim command.
```bash
$ neobundle clean
```
#### list
-This command will enumerate the Vim plugins by the NeoBundle which is described the `vimrc`.
-It equals the `:NeoBundleList` vim command.
+This command will enumerate the Vim plugins by the NeoBundle which is described the bundle file.
+It equals the `:NeoBundleList` Vim command.
```bash
$ neobundle list
```
### options
#### --vim
-This option designates the vim command location.
+This option designates the `vim` command location.
```bash
---vim=<path>
+-c <path>, --vim=<path>
```
The default value is `vim`, and this case is searched from the `PATH` environment variable by the system.
Also, this value is able to overriden by the `NEOBUNDLE_CMD_VIM` environment variable.
-#### --vimrc
+#### --bundlefile
-This option designates the vimrc location.
+This option designates the bundle file location.
```bash
---vimrc=<path>
+-f <path>, --bundlefile=<path>
```
The default value is shown below:
| platform | value |
| -------- | ----- |
| Mac OS X and Linux | $HOME/.vimrc |
| Windows | %USERPROFILE%\\\_vimrc |
-Also, this value is able to overriden by the `NEOBUNDLE_CMD_VIMRC` environment variable.
+Also, this value is able to overriden by the `NEOBUNDLE_CMD_BUNDLEFILE` environment variable.
+
+#### --verbose
+
+This option is the Vim script log level. In the ordinary, do not need to use this option,
+but for example, when wanted to trace the errors of the bundle file, this option will assist.
+
+```bash
+-V <level>, --verbose=<level>
+```
+
+The default value is 0.
+
+### return value
+
+This command return value is listed below:
+
+| value | state |
+| ----- | ----- |
+| 0 | Success |
+| 1 | Error |
+| 2 | No operation |
+
+*NOTE: The "No operation" return value will be returned when the command of the `install` or `clean` did nothing.*
## Contributing
1. Fork it ( https://github.com/mrk21/neobundle-cmd/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)