1 files changed, 29 insertions, 0 deletions
diff --git a/atom/packages/ex-mode/README.md b/atom/packages/ex-mode/README.md
new file mode 100644
index 0000000..b3084de
--- /dev/null
+++ b/atom/packages/ex-mode/README.md
@@ -0,0 +1,29 @@
+# ex-mode package
+
+ex-mode for Atom's vim-mode
+
+## 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...")
+```
+
+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