aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGene Pasquet <dev@etenil.net>2022-11-15 14:45:01 +0000
committerGene Pasquet <dev@etenil.net>2022-11-15 14:45:01 +0000
commitc724844da1f731460f83811378a781991d25f571 (patch)
tree80a68f7cb13c57ea18a73caad4ed0afe6e118953 /README.md
parent5e9a882c566c2f1bf35dec651f865002e741ab55 (diff)
Improved readme.
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 36 insertions, 3 deletions
diff --git a/README.md b/README.md
index 0cd70ac..17f18ed 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,41 @@
# BARB-MODE
-
-## Getting started
-
Barb-mode is a major mode for emacs to edit and interact with request
files for the [barb](https://gitlab.com/guillaume54/barb) HTTP query
tool.
+
+![Animated demo](demo.gif)
+
+## Installation
+
+The supported method of installation is through the package manager
+[straight.el](https://github.com/radian-software/straight.el). In
+order to install barb-mode, add the following to your `init.el`:
+
+```lisp
+(straight-use-package
+ '(barb-mode
+ :type git
+ :host gitlab
+ :repo "guillaume54/barb-mode"))
+```
+
+Then restart emacs.
+
+## Usage
+
+The mode will be automatically loaded whenever a `.barb` file is
+visited. If you have chosen to use a different file extension, you can
+start the mode by typing `M-x barb-mode`.
+
+The mode provides syntax highlighting for the *barb* preamble and
+allows easy execution of the request directly in emacs by typing `C-c
+C-c`.
+
+## Running a barb file
+
+In order to execute a barb file, the
+[barb](https://gitlab.com/guillaume54/barb#installation) executable
+must be installed on your system and on the `PATH`. Then pressing `C-c
+C-c` should work.
+