ex-mode/README.md

33 lines
942 B
Markdown

# ex-mode package
ex-mode for Atom's vim-mode
**I now only rarely use Atom and am looking for a new maintainer for this project. Please chime in [here](https://github.com/lloeki/ex-mode/issues/116).**
## Use
Install both [vim-mode](https://github.com/atom/vim-mode) and ex-mode. Type `:` in command mode. Enter `w` or `write`.
## Extend
Use the service to register commands, from your own package, or straight from `init.coffee`:
```coffee
# in Atom's init.coffee
atom.packages.onDidActivatePackage (pack) ->
if pack.name == 'ex-mode'
Ex = pack.mainModule.provideEx()
Ex.registerCommand 'z', -> console.log("Zzzzzz...")
# Register an alias - Now :W acts like :w
Ex.registerAlias 'W', 'w'
```
See `lib/ex.coffee` for some examples commands. Contributions are very welcome!
## Status
Groundwork is done. More ex commands are easy to add and will be coming as time permits and contributions come in.
## License
MIT