Skip to content

Commit 734e6e7

Browse files
committed
docs: some tweaks
1 parent 5d71932 commit 734e6e7

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

doc/rest-nvim.txt

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,6 @@ FEATURES *rest-nvim-features*
4646
===============================================================================
4747
QUICK START *rest-nvim-quick-start*
4848

49-
For now `rest.vnim` uses a JSON-based syntax for its operations. That means
50-
that by example, to send headers a syntax of `{key: value}` is used.
51-
5249
In this section we will be using `https://reqres.in/` for requests.
5350

5451
Let's say we want to create a new user and send our body as a JSON, so we
@@ -59,7 +56,7 @@ will do the following:
5956

6057
2. Since we want to send our body as a JSON object, we set the
6158
Content-Type header.
62-
`"Content-Type": "application/json"`
59+
`Content-Type: application/json`
6360

6461
3. Now, we set the body of our request.
6562
`{`
@@ -79,7 +76,8 @@ exposes a command to be mapped. See |rest-nvim-usage-commands|
7976
USAGE *rest-nvim-usage*
8077

8178
Create a new http file or open an existing one and place the cursor over the
82-
request method (e.g. `GET`) and run `rest.nvim` (see |rest-nvim-usage-commands|).
79+
request line (e.g. `GET http://localhost:3000/foo`) and run `rest.nvim`
80+
(see |rest-nvim-usage-commands|).
8381

8482
Notes:
8583
- `rest.nvim` follows the RFC 2616 request format so any other http file
@@ -89,8 +87,7 @@ Notes:
8987
===============================================================================
9088
COMMANDS *rest-nvim-usage-commands*
9189

92-
`<Plug>RestNvim`
93-
Run `rest.nvim` in the current cursor position.
90+
| `<Plug>RestNvim` | Run `rest.nvim` in the current cursor position.
9491

9592

9693
===============================================================================

0 commit comments

Comments
 (0)