diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 63a1d11..89d0719 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -1,2 +1,2 @@
# Any change to files in the root directory, any later match takes precedence.
-* @NTBBloodbath
+* @NTBBloodbath @boltlessengineer
diff --git a/README.md b/README.md
index 16ea555..33c44b6 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,8 @@
# rest.nvim

-
+
[](https://luarocks.org/modules/teto/rest.nvim)
-[](https://discord.gg/AcXkuXKj7C)
-[](https://matrix.to/#/#rest.nvim:matrix.org)
[Features](#features) • [Install](#install) • [Usage](#usage) • [Contribute](#contribute)
@@ -18,12 +16,12 @@
A very fast, powerful, extensible and asynchronous Neovim HTTP client written in Lua.
-`rest.nvim` by default makes use of native [cURL](https://curl.se/) bindings. In this way, you get
-absolutely all the power that cURL provides from the comfort of our editor just by using a keybind
-and without wasting the precious resources of your machine.
+`rest.nvim` by default makes use of its own `curl` wrapper made in pure Lua and a [tree-sitter]
+parser to parse `http` files. So what you can run get exact and detailed result what you see from
+your editor!
In addition to this, you can also write integrations with external HTTP clients, such as the postman
-CLI. For more information on this, please see this [blog post](https://amartin.codeberg.page/posts/first-look-at-thunder-rest/#third-party-clients).
+CLI.
> [!IMPORTANT]
>
@@ -65,24 +63,35 @@ CLI. For more information on this, please see this [blog post](https://amartin.c
}
```
-### [packer.nvim](https://github.com/wbthomason/packer.nvim)
+
+
+
+
+
+
+
+
+
+
+### Setup
+
+No `.setup()` call is needed!
+Just set your options via `vim.g.rest_nvim`. It is fully documented and typed internally so you get
+a good experience during autocompletion :)
```lua
-use {
- "rest-nvim/rest.nvim",
- rocks = { "nvim-nio", "mimetypes", "xml2lua", "fidget.nvim" },
+---@type rest.Opts
+vim.g.rest_nvim = {
+ -- ...
}
```
-### Default configuration
-
-This is the default configuration of `rest.nvim`, it is fully documented and typed internally so you
-get a good experience during autocompletion :)
-
> [!NOTE]
>
> You can also check out `:h rest-nvim.config` for documentation.
+### Default configuration
+
```lua
---rest.nvim default configuration
---@class rest.Config
@@ -159,22 +168,10 @@ local default_config = {
}
```
-### Tree-Sitter parsing
-
-`rest.nvim` uses tree-sitter as a first-class citizen, so it will not work if the required parsers are
-not installed. These parsers are as follows and you can add them to your `ensure_installed` table
-in your `nvim-treesitter` configuration.
-
-```lua
-ensure_installed = { "lua", "xml", "http", "json", "graphql" }
-```
-
-Or manually run `:TSInstall lua xml http json graphql`.
-
## Usage
-Create a new http file or open an existing one and place the cursor over the
-request and run the :Rest run command.
+Create a new http file or open an existing one and run the :Rest run {name} command, or
+just place the cursor over the request and simply run :Rest run.
> [!NOTE]
>
@@ -223,7 +220,7 @@ response.body = vim.json.encode(json)
```
Put `# @lang=lua` comment just above any script elements.
-Scripts without `@lang` will be parsed as javascript code to match with [http spec](https://www.jetbrains.com/help/idea/exploring-http-syntax.html#response-handling)
+Scripts without `@lang` will be parsed as javascript code to match with [http spec](https://www.jetbrains.com/help/idea/exploring-http-syntax.html#response-handling).
## Extensions
@@ -313,3 +310,5 @@ test runner through `make test` will automatically install all required dependen
## License
rest.nvim is [GPLv3 Licensed](./LICENSE).
+
+[tree-sitter]: https://github.com/tree-sitter/tree-sitter