From 537493917a7738b4b720e0c43ad5e0268e41b6c6 Mon Sep 17 00:00:00 2001 From: Guillaume Pasquet Date: Wed, 21 Feb 2024 09:45:02 +0000 Subject: Initial commit --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac2e298 --- /dev/null +++ b/README.md @@ -0,0 +1,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. \ No newline at end of file -- cgit v1.2.3