vim-scripts · boypt · Jun 19, 2012 · Jun 19, 2012 · Jun 20, 2012 · Jun 20, 2012
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+doc/tags
+.hg
+.svn
+.hg*
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,57 @@
+#Welcome
+VimRepress is a plugin for managing WordPress blog from Vim, using Markdown syntax.
+
+##Features
+ * NEW/EDIT/DELETE WordPress Posts/Pages.
+ * In both Markdown / HTML format.
+ * Markdown text can be configured to be stored in the custom fields of WordPress.
+ * Upload attachments.
+ * Insert code highlight section.
+ * Preview a posts in local compiled version, or remote draft.
+ * WordPress.com account supported.
+ * Multiple account supported.
+
+##Commands Reference
+ * BlogList     [post|page]
+ * BlogNew      [post|page]
+ * BlogSave     [publish|draft]
+ * BlogPreview  [local|publish|draft]
+ * BlogUpload   *[path/to/your/local/file]
+ * BlogOpen     *[post id or full article URL]
+ * BlogSwitch   [0,1,2 ... N, number of account in your config]
+ * BlogCode     [type of lang for the \<pre\> element]
+
+  (Commands with a `*`, argument must be present.)
+
+
+##CONFIGURE
+
+Create file `~/.vimpressrc` in the following format:
+
+    [Blog0]
+    blog_url = http://a-blog.com/
+    username = admin
+    password = 123456
+
+    [Blog1]
+    blog_url = https://blog1.wordpress.com/
+    username = someone
+    password =
+    store_markdown = n
+
+    [BlogWhatEver]
+    blog_url = https://someone.wordpress.com/
+    username = someone
+    password =
+
+Hardcoding the password is optional. If a password is not provided the plugin will prompt for one the first time it's needed.
+
+`store_markdown` is also optional. If not specified then Markdown text will be stored in custom fields of WordPress. If set to `n` then the Markdown text will not be stored.
+
+###For Upgraded Users
+
+Defining account info in `.vimrc` is now obsolesced, if you have correspond defination in `.vimrc` (for older version vimpress), they will automaticly copied into `~/.vimpressrc`, now you're safe to remove the VIMPRESS defination in `.vimrc`.
+
+Users from the 2.x.x versions of vimrepress, need to run the `markdown_posts_upgrade.py` to upgrade the their posts data to be compatible with the 3.x.x version of vimrepress, or their Markdown source can not be used to re-edit by a newer vimrepress. 
+
+
diff --git a/doc/vimpress.txt b/doc/vimpress.txt
@@ -17,27 +17,33 @@ License:  Same terms as Vim itself (see |license|)
 
 *INSTALL*
 
-Download vimpress_2.x.x.zip, extract it in your .vim directory:
+Download vimpress_x.x.x.zip, extract it in your .vim directory:
 
   cd ~/.vim
-  unzip /path/to/vimpress_2.x.x.zip
+  unzip /path/to/vimpress_x.x.x.zip
 
 *CONFIGURE*
 
-Edit ~/.vimrc , add a variable named VIMPRESS. Multiple blog configurations are supported.
+Create file `~/.vimpressrc' in the following format:
 
-Example:
+    [Blog0]
+    blog_url = http://a-blog.com/
+    username = admin
+    password = 123456
 
-let VIMPRESS = [{'username':'user',
-                \'password':'pass',
-                \'blog_url':'http://your-first-blog.com/'
-                \},
-                \{'username':'user',
-                \'blog_url':'http://your-second-blog.com/'
-                \}]
+    [Blog1]
+    blog_url = https://someone.wordpress.com/
+    username = someone
+    password =
 
-Hardcoding the password is optional. If a password is not provided the plugin
-will prompt for one the first time it's needed.
+>
+For Upgraded Users:
+
+    Defining Account info in `.vimrc` is now obsolesced, if you have correspond defination in `.vimrc', they will automaticly copied into `~/.vimpressrc', now you're safe to remove the VIMPRESS defination in `.vimrc'.
+<
+
+Hardcoding the password is optional. If a password is not provided,
+the plugin will prompt for one the first time it's needed.
 
 If you need Markdown support, simply run `sudo apt-get install python-markdown' in Ubuntu. 
 
@@ -125,61 +131,3 @@ Some commands list above contain special usage, example below may clearify them
     :BlogOpen http://your-third-blog.com/with-your-custom-permalink
 <
 
-*CHANGE_LOG*
-
- 2011 May. 15 [by Preston]
-               Upgrade to 2.0 beta
-               Different command structure
-               Markdown file uploaded when post is saved and interpreted
-                when opened.
-               The open command takes many types of parameters
-
-              [by Conner]
-               Add: autocompletion for tags and categories with ^X^U
-               Add: prompts for password when not hardcoded
-               Add: BlogSwitch now accepts an index parameter
-               Add: Delete function in BlogList view.
-               *Add: HTML highlighting for blog syntax
-               *Add: Delete command
-               *(not yet included in Preston's release version)
-
- 2011 Mar. 24 [by Lenin Lee]
-               Fix: use setl instead of set to set option value;
-               Add: Detect current buffer content before switch to vimpress 
-               views, open a split buffer to avoid conflicts.
-               Add: Commands to manage wordpress pages.
-
-               [by Preston]
-               Add: Auto charset convert for non-utf8 environment.(Win)
-               Add: Use python markdown module. Both markdown and markdown2
-               are supported.
-
- 2011 Mar. 15 [by Preston]
-               Fix: MarkdownNewPost may override original mkd source file.
-               Add: MarkdownNewPost command detects title begins with
-                   "#" in first 10 lines of markdown source, copy the line
-                   striped "#" to the new post view.
-
- 2011 Mar. 7  [by Preston]
-               Add: MarkdownPreview command to preiview markdown in browser.
-               Add: MarkdownNewPost command to convert a markdown
-               written post into html and set to the new post view.
-
-
- 2011 Mar. 4  [by Preston]
-               Add: Move blog config info to personal .vimrc
-               Add: Multiple blog config is now supported with :BlogSwitch
-               command.
-               Add: Show which blog your editing at :BlogList view.
-               Fix: bug running :BlogList in the List view got error.
-
- 2011 Feb. 15 [by Preston]
-               Add: BlogPreview Command.
-               Add: BlogCode command args to specify code type
-               Change: blog_url uses pure address.
-               Code: Some code pretty work.
-
- 2010 Aug. 20 [by Justin] 
-               Fixed a bug with BlogSave command, and added feature to take
-               an existing document and use the BlogNew command to convert 
-               it to a blog post (which can be saved with the header intact).