diff --git a/README.md b/README.md index 61595cd..5ce923d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,39 @@ -# notational-velocity package +# Notational Velocity for Atom -A short description of your package. +[Notational Velocity][1] is an application that stores and retrieves notes. This Atom package implements the some key features from this amazing app: -![A screenshot of your spankin' package](https://f.cloud.github.com/assets/69169/2290250/c35d867a-a017-11e3-86be-cd7c5bf3ff9b.gif) +- Modeless operation +- Mouseless interaction +- Incremental Search + +Integrated with Atom, we have many advantages: + +- __Use Atom's Features__ - Such as Syntax Highlighting and Tree View. +- __Use Other Packages__ - Such as Markdown Preview and Minimap. +- __Multi-OS__ - You can use it in Linux and Windows. + +We do believe Notational Velocity is the precursor of the famous note-taking app Evernote. Advantages over Evernote are: + +- __Open Source__ +- __No Rich Text__ - Instead, we strongly recommend to use [Markdown][2]. +- __No Cloud Sync__ - You pick whichever syncing method you prefer. + +## Settings + +- `Directory`: The directory of archiving markdown files. + +## Key Bindings + +- `ctrl-alt-o`: Toggles the search view. + +## References + +- [Notational Velocity](http://notational.net/) +- [nvALT](http://brettterpstra.com/projects/nvalt/) +- [Markdown](http://daringfireball.net/projects/markdown/) +- [CommonMark](http://commonmark.org/) +- [Evernote](https://evernote.com/) +- [Simplenote](http://simplenote.com/) + +[1]: http://notational.net/ +[2]: http://daringfireball.net/projects/markdown/syntax