Permalink
Browse files

Version 0.4.0: plugin uses autoload structure now

  • Loading branch information...
1 parent 337bf70 commit 21d7eb053951297f6df10f96da00a8de17ac15ca @mrtazz mrtazz committed with Feb 9, 2012
Showing with 757 additions and 597 deletions.
  1. +30 −0 CHANGELOG.md
  2. +20 −0 LICENSE
  3. +92 −0 README.md
  4. +610 −0 autoload/simplenote.vim
  5. +5 −597 plugin/simplenote.vim
View
@@ -0,0 +1,30 @@
+# Changelog
+
+## 0.3.0 (07/17/2011)
+
+- UTF-8 support
+- create new notes from buffer via :Simplenote -n
+- update note when buffer is written
+- support direct deletion of notes via :Simplenote -D
+- support tagging of notes via :Simplenote -t
+- distinct buffer for every note
+- use simplenote.py for API interaction
+- encapsulate interface methods in Python class
+
+## 0.2.0 (05/30/2011)
+
+- change interface function to Simplenote
+- truncate long note titles in list
+- display modified date instead of note key in list
+- load all notes for index
+- don't display notes from trash
+- deferred token retrieval and simple caching
+- Wrapped username, password and token in urllib2's quote method
+- improve time needed for listing notes
+
+## 0.1.0 (05/10/2011)
+
+- SimpleNote -l: list notes in scratch buffer
+- SimpleNote -u: update note from buffer
+- SimpleNote -d: move note to trash
+
View
20 LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Schauenberg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -0,0 +1,92 @@
+# simplenote.vim
+A vim plugin to interact with the [simplenote][1] API. You can create an
+account [here](https://simple-note.appspot.com/create) if you don't already
+have one.
+Now you can take simple notes directly from your favourite editor.
+
+## Installation
+Just copy `simplenote.vim` into your plugin folder. But you really want to use
+[pathogen][5] for your plugin management.
+
+Your credentials have to be stored in your `vimrc`:
+
+ let g:SimplenoteUsername = "your simplenote username"
+ let g:SimplenotePassword = "your simplenote password"
+
+If you don't want to have the credentials in your `vimrc` (if you manage it
+with git for example), you can just set the variables in a different file (like
+`~/.simplenoterc`) and source it with `source ~/.simplenoterc` in your `vimrc`.
+
+## Usage
+The plugin provides several commands to interact with your Simplenote account.
+In order to retrieve a list of your notes execute
+
+ :Simplenote -l
+
+This opens a new scratch buffer with a line-wise listing of your notes. You can
+navigate through these with the arrow keys and enter a note on hitting
+`Return`. Now that you see the content of the note, you can interact with this
+specific note:
+
+ :Simplenote -u
+
+updates the content of the current note with the content of the current buffer.
+If you want to delete the note, execute
+
+ :Simplenote -d
+
+This moves the current note to the trash. If you want to completely delete a
+note, use
+
+ :Simplenote -D
+
+as it will directly delete the note and not only move it to the trash.
+There also exists a command to create new notes.
+
+ :Simplenote -n
+
+creates a new note with the contents of the current buffer. Once the note is
+created, `:Simplenote -u` updates the newly created note, also with the
+contents of the current buffer.
+Tagging notes is also supported. If you enter
+
+ :Simplenote -t
+
+on a buffer containing a valid note, you get an input dialog, prefilled with
+existing comma-separated tags for the note, which you can then edit. Tags have
+to be comma separated and hitting `Enter` will then update the note with the
+new tag list.
+
+## Dependencies
+Version 2 of the SimpleNote API relies heavily on JSON. As JSON and VimL don't
+really play nice together, basic parts of this plugin are implemented in
+python. Therefore your vim has to be compiled with python support in order to
+use this plugin.
+
+## Usage behind proxy
+Since the plugin uses Python's urllib2 for making HTTP requests, you just have to
+add these lines (with the correct values) to your `.vimrc`:
+
+ let $HTTP_PROXY = 'http://<proxyuser>:<proxypassword>@<proxyurl>:<proxyport>'
+ let $HTTPS_PROXY = 'http://<proxyuser>:<proxypassword>@<proxyurl>:<proxyport>'
+
+
+## Development
+- [Planned features](http://www.pivotaltracker.com/projects/288621)
+- [Bugs and issue tracker](https://github.com/mrtazz/simplenote.vim/issues)
+
+## Contribute
+- Fork the project
+- Branch off develop
+- Make your additions/fixes/improvements
+- Send a pull request
+
+## Thanks
+[mattn][2], [Tim Pope][3] and [Scrooloose][4] who write awesome vim plugins
+which I took as a basis to learn how to write vim plugins.
+
+[1]: http://simplenoteapp.com/
+[2]: http://github.com/mattn
+[3]: http://github.com/tpope
+[4]: http://github.com/scrooloose
+[5]: http://github.com/tpope/vim-pathogen
Oops, something went wrong.

0 comments on commit 21d7eb0

Please sign in to comment.