aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: ac2e298b5363c7f4d9cd87842a46b8368f001366 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Semver.el

Semver.el is an Emacs plugin to interpret semver constraints in an
easier to understand form, because no one wants to screw up their
version constraints!

![Semver.el outputting version constraints from a semver string](emacs-semver.png)

## How to install

Download semver.el and place it in your emacs load path, then put the
following in your configuration file:

```elisp
(require 'semver)

(keymap-global-set "C-c C-l" #'semver--expand-at-point)
```

## Usage

This package exposes two interactive functions `semver--expand` and
`semver--expand-at-point`. The first will prompt for a semver string
to expand, whereas the second will attempt to read a semver string
where your cursor is and print the version constraint in the echo
area.