diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 39 |
1 files changed, 36 insertions, 3 deletions
@@ -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. + + + +## 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. + |