git.r.bdr.sh - rbdr/dotfiles/blob - atom/packages/ex-mode/README.md

   1 # ex-mode package
   2
   3 ex-mode for Atom's vim-mode
   4
   5 ## Use
   6
   7 Install both [vim-mode](https://github.com/atom/vim-mode) and ex-mode. Type `:` in command mode. Enter `w` or `write`.
   8
   9 ## Extend
  10
  11 Use the service to register commands, from your own package, or straight from `init.coffee`:
  12
  13 ```coffee
  14 # in Atom's init.coffee
  15 atom.packages.onDidActivatePackage (pack) ->
  16   if pack.name == 'ex-mode'
  17     Ex = pack.mainModule.provideEx()
  18     Ex.registerCommand 'z', -> console.log("Zzzzzz...")
  19 ```
  20
  21 See `lib/ex.coffee` for some examples commands. Contributions are very welcome!
  22
  23 ## Status
  24
  25 Groundwork is done. More ex commands are easy to add and will be coming as time permits and contributions come in.
  26
  27 ## License
  28
  29 MIT