Update docs

Author: diepm

README.md

@@ -219,6 +219,36 @@ merged with any global headers. Local headers overwrite global headers.
     POST /service
     var1=value
 
+#### 5.2 Line-by-line Request Body
+
+Since version 2.3.0, the request body can be specified on a line-by-line
+basis. It's useful for name-value pair services. Each line of the request
+body is passed to cURL using `--data` or `--data-urlencode` depending on
+the verb.
+
+To enable,
+
+    let g:vrc_split_request_body = 1
+
+or
+
+    let b:vrc_split_request_body = 1
+
+Then the request body can be specified as
+
+    #
+    # The following params in the request body will be
+    # sent using `--data-urlencode`
+    #
+    http://localhost
+    Content-Type: text/html; charset=UTF-8
+    GET /service
+    var1=value1
+    var2=value2
+
+This option won't take effect for `GET` request if the option
+`vrc_allow_get_request_body` is set.
+
 ### 6. Configuration
 
 VRC supports a few configurable variables. Each of them can have a global or
@@ -231,43 +261,64 @@ or in Vim for the buffer scope by
 
     let b:option_name = value
 
-#### `vrc_trigger`
+#### `vrc_allow_get_request_body`
 
-This option defines the trigger key. It's `<C-j>` by default. To remap the key,
+Allow GET request to have a request body or not. Default: 0.
 
-    let g:vrc_trigger = '<C-k>'
+If this option is set, `-X GET` is used and the request body is passed to
+cURL as a whole using `--data`.
 
-#### `vrc_ssl_secure`
+This option is useful for such services as ElasticSearch.
 
-This option tells cURL to check or not check for the SSL certificates. It's
-turned off by default. To enable,
+    #
+    # With vrc_allow_get_request_body = 1
+    #
+    http://localhost:9200
+    Content-Type: application/json
 
-    let g:vrc_ssl_secure = 1
+    GET /testindex/testtype/_search
+    {
+      "query": {
+        "match": { "name": "FOO" }
+      }
+    }
 
-#### `vrc_output_buffer_name`
+Be careful that when this option is enabled, the request body is always sent
+as a whole regardless of `vrc_split_request_body`.
 
-This option sets the name for the output/display buffer. By default, it's set
-to `__REST_response__`. To assign a different name,
+#### `vrc_auto_format_response_enabled`
 
-    let g:vrc_output_buffer_name = '__NEW_NAME__'
+This option enables the automatic formatting of the response. It's enabled by
+default. To disable:
 
-This option is useful in working with multiple VRC buffers where each one has
-its own output display. For this, the option can be set in the buffer scope as
+    let g:vrc_auto_format_response_enabled = 0
 
-    let b:vrc_output_buffer_name = '__REST_1_OUTPUT__'
+If `vrc_include_response_header` is disabled, this option does nothing.
 
-#### `vrc_header_content_type`
+#### `vrc_auto_format_response_patterns`
 
-This option is to set the header content type of the request. It defaults to
-`application/json`. To set a different default content type,
+This option defines which external tools to use to auto-format the response
+body according to the Content-Type.
 
-    let g:vrc_header_content_type = 'application/x-www-form-urlencoded'
+The defaults are:
 
-It can also be set in the buffer scope by
+    let s:vrc_auto_format_response_patterns = {
+    \   'json': 'python -m json.tool',
+    \   'xml': 'xmllint --format -',
+    \}
 
-    let b:vrc_header_content_type = 'application/json; charset=utf-8'
+Adjust the list by defining the global or buffer variable, like so:
 
-If `Content-Type` is specified in the request block, it overrides this setting.
+    let g:vrc_auto_format_response_patterns = {
+    \   'json': ''
+    \   'xml': 'tidy -xml -i -'
+    \}
+
+If `vrc_include_response_header` is disabled, this option does nothing.
+
+#### `vrc_connect_timeout`
+
+Corresponding to cUrl option `--connect-timeout`. Default: 10 seconds.
 
 #### `vrc_cookie_jar`
 
@@ -280,16 +331,11 @@ It can also be set in the buffer scope by
 
     let b:vrc_cookie_jar = './jar'
 
-#### `vrc_set_default_mapping`
-
-This option is to enable/disable the trigger key mapping. It's enabled by
-default. To disable the mapping,
-
-    let g:vrc_set_default_mapping = 0
-
-Once the mapping is disabled, the request block can be executed by
+#### `vrc_debug`
 
-    :call VrcQuery()
+This option enables the debug mode by adding the `-v` option to the *curl*
+command and also `echom` the command to the Vim console. It's turned off by
+default.
 
 #### `vrc_follow_redirects`
 
@@ -298,6 +344,19 @@ redirects. It's turned off by default. To enable
 
     let g:vrc_follow_redirects = 1
 
+#### `vrc_header_content_type`
+
+This option is to set the header content type of the request. It defaults to
+`application/json`. To set a different default content type,
+
+    let g:vrc_header_content_type = 'application/x-www-form-urlencoded'
+
+It can also be set in the buffer scope by
+
+    let b:vrc_header_content_type = 'application/json; charset=utf-8'
+
+If `Content-Type` is specified in the request block, it overrides this setting.
+
 #### `vrc_include_response_header`
 
 This option enables the inclusion of the response header information mode by
@@ -312,35 +371,50 @@ If this option is disabled, the following options will not take effect.
 * `vrc_auto_format_response_patterns`
 * `vrc_syntax_highlight_response`
 
-#### `vrc_auto_format_response_enabled`
+#### `vrc_max_time`
 
-This option enables the automatic formatting of the response. It's enabled by
-default. To disable:
+Corresponding to cUrl option `--max-time`. Default: 60 seconds.
 
-    let g:vrc_auto_format_response_enabled = 0
+#### `vrc_output_buffer_name`
 
-If `vrc_include_response_header` is disabled, this option does nothing.
+This option sets the name for the output/display buffer. By default, it's set
+to `__REST_response__`. To assign a different name,
 
-#### `vrc_auto_format_response_patterns`
+    let g:vrc_output_buffer_name = '__NEW_NAME__'
 
-This option defines which external tools to use to auto-format the response
-body according to the Content-Type.
+This option is useful in working with multiple VRC buffers where each one has
+its own output display. For this, the option can be set in the buffer scope as
 
-The defaults are:
+    let b:vrc_output_buffer_name = '__REST_1_OUTPUT__'
 
-    let s:vrc_auto_format_response_patterns = {
-    \   'json': 'python -m json.tool',
-    \   'xml': 'xmllint --format -',
-    \}
+#### `vrc_set_default_mapping`
 
-Adjust the list by defining the global or buffer variable, like so:
+This option is to enable/disable the trigger key mapping. It's enabled by
+default. To disable the mapping,
 
-    let g:vrc_auto_format_response_patterns = {
-    \   'json': ''
-    \   'xml': 'tidy -xml -i -'
-    \}
+    let g:vrc_set_default_mapping = 0
 
-If `vrc_include_response_header` is disabled, this option does nothing.
+Once the mapping is disabled, the request block can be executed by
+
+    :call VrcQuery()
+
+#### `vrc_split_request_body`
+
+Determine if the request body should be processed line by line. Default: 0.
+
+If this option is set, each line of the request body is passed to cURL using
+either `--data` or `--data-urlencode` depending on the verb.
+
+If the verb is `GET` and the option `vrc_allow_get_request_body` is enabled,
+this option doesn't take effect; the request body is always sent as a whole
+using `--data`.
+
+#### `vrc_ssl_secure`
+
+This option tells cURL to check or not check for the SSL certificates. It's
+turned off by default. To enable,
+
+    let g:vrc_ssl_secure = 1
 
 #### `vrc_syntax_highlight_response`
 
@@ -351,19 +425,11 @@ the Content-Type. It's enabled by default. To disable:
 
 If `vrc_include_response_header` is disabled, this option does nothing.
 
-#### `vrc_connect_timeout`
-
-Corresponding to cUrl option `--connect-timeout`. Default: 10 seconds.
-
-#### `vrc_max_time`
-
-Corresponding to cUrl option `--max-time`. Default: 60 seconds.
+#### `vrc_trigger`
 
-#### `vrc_debug`
+This option defines the trigger key. It's `<C-j>` by default. To remap the key,
 
-This option enables the debug mode by adding the `-v` option to the *curl*
-command and also `echom` the command to the Vim console. It's turned off by
-default.
+    let g:vrc_trigger = '<C-k>'
 
 ### 7. Tips 'n Tricks
 
@@ -397,6 +463,7 @@ Thanks to the contributors (in alphabetical order)
     @jojoyuji
     @korin
     @mjakl
+    @nathanaelkane
     @p1otr
     @rlisowski
     @sethtrain
@@ -406,6 +473,11 @@ Thanks to the contributors (in alphabetical order)
 
 ### 9. Changelog
 
+#### 2.3.0 (2016-03-24)
+
+* GET request can have request body.
+* Request body can be specified on a line-by-line basis.
+
 #### 2.2.0 (2016-02-08)
 
 * Add support for PATCH, OPTIONS, and TRACE.