Skip to content

Commit

Permalink
docs: add usage
Browse files Browse the repository at this point in the history
  • Loading branch information
jellydn committed Oct 21, 2023
1 parent 864df21 commit c8cc7ff
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
<h1 align="center">Welcome to hurl.nvim 👋</h1>
<p>
TBD
<strong>Hurl.nvim</strong> is a Neovim plugin that brings the power of the Hurl command line tool into your editor. Designed to run HTTP requests from `.hurl` files, this plugin simplifies the API development process, making it both efficient and versatile.
</p>

## Table of Contents
<!--toc:start-->
- [Usage](#usage)
- [Features](#features)
- [Credits](#credits)
- [Show your support](#show-your-support)
<!--toc:end-->

## Features

- 🚀 Execute HTTP requests directly from `.hurl` files.
- 👁‍🗨 Multiple display modes for API response: popup or quickfix.
- 🌈 Highly customizable through Neovim settings.

## Usage

Add the following configuration to your Neovim setup:

```lua
{
"jellydn/hurl.nvim",
Expand All @@ -30,7 +46,8 @@

## Credits

Inspired by [ray-x/web-tools.nvim: Neovim plugin for web developers](https://github.com/ray-x/web-tools.nvim)
- Inspired by [ray-x/web-tools.nvim: Neovim plugin for web developers](https://github.com/ray-x/web-tools.nvim)
- Utilize [MunifTanjim/nui.nvim: UI components for Neovim plugins and configurations](https://github.com/MunifTanjim/nui.nvim)
## Show your support

Give a ⭐️ if this project helped you!
1 change: 1 addition & 0 deletions hurl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ systemlist
bufnr
Tanjim
quickfix
Munif

0 comments on commit c8cc7ff

Please sign in to comment.