Version bump

rvaiya · Apr 20, 2022 · 90c3687 · 90c3687
1 parent 65984d3
commit 90c3687
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 13 deletions.
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@
 DESTDIR=
 PREFIX=/usr
 
-VERSION=2.3.1-rc
+VERSION=2.4.0
 COMMIT=$(shell git describe --no-match --always --abbrev=7 --dirty)
 VKBD=uinput
 

diff --git a/README.md b/README.md
@@ -6,15 +6,11 @@ result often being tethered to a specified environment (X11). keyd attempts to
 solve this problem by providing a flexible system wide daemon which remaps keys
 using kernel level input primitives (evdev, uinput).
 
-# UPDATE (v2.3.0-rc)
+# UPDATE (v2.4.0 released)
 
-master is currently tracking `v2.3.0-rc`. Things should be reasonably backwards
-compatible, but minor changes may be introduced before the final release. If
-you are looking for something a bit more stable you may be interested the
-[v1](https://github.com/rvaiya/keyd/tree/v1) branch.
-
-*NOTE: For those migrating their configs from v1, please see the
-[changelog](docs/CHANGELOG.md) for a list of changes.*
+The config format has undergone several iterations since the first
+release, for those migrating their configs from v1, please see the
+[changelog](docs/CHANGELOG.md)*.
 
 # Goals
 
@@ -36,8 +32,9 @@ Some of the more interesting ones include:
 - Keyboard specific configuration.
 - Instantaneous remapping (no more flashing :)).
 - A client-server model that facilitates scripting and display server agnostic application remapping. (Currently ships with support for X, sway, and gnome).
-- System wide config (works in a VT)
+- System wide config (works in a VT).
 - First class support for modifier overloading.
+- Unicode support.
 
 ### keyd is for people who:
 
@@ -52,7 +49,6 @@ Some of the more interesting ones include:
 
 ### What keyd isn't:
 
- - A tool for launching arbitrary system commands as root.
  - A tool for programming individual key up/down events.
 
 # Dependencies
@@ -67,6 +63,10 @@ Some of the more interesting ones include:
 
 # Installation
 
+*Note:* master serves as the development branch, things may occasionally break
+between releases. Releases can be found in the
+[stable](https://github.com/rvaiya/keyd/tree/stable) branch.
+
 ## From Source
 
     git clone https://github.com/rvaiya/keyd

diff --git a/data/keyd-application-mapper.1.gz b/data/keyd-application-mapper.1.gz
diff --git a/data/keyd.1.gz b/data/keyd.1.gz
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,3 +1,15 @@
+# v2.4.0
+
+ Fix macro timeouts
+ Allow timeouts to be used in conjunction with + (#181)
+ Add macro2() to allow for per-macro timeout values (#176)
+ Add command() to allow for command execution
+ Add [global] section
+ Improve unicode support
+ Add support for older kernels (#163)
+ Clear oneshot on click
+ Various bugfixes and enhancements
+
 # v2.3.1-rc
 
  - Add unicode support

diff --git a/docs/keyd.scdoc b/docs/keyd.scdoc
@@ -379,8 +379,8 @@ arguments.
 
 	command(brightness down)
 
-*NOTE:* Commands are executed by root, which means any user which has access
-to the keyd socket should be assumed to have root access.
+*NOTE:* Commands are executed by the user running the keyd process (probably root), 
+use this feature judiciously.
 
 *noop*
 	Do nothing.
@@ -403,6 +403,9 @@ is a good example of this. It is a small python script which performs event
 detection for the various display servers (e.g X/sway/gnome, etc) and feeds the
 desired mappings to the core using _-e_.
 
+*NOTE:* Users with access to the keyd socket should be considered privilleged
+(i.e assumed to have access to the entire system.).
+
 ## Expressions
 
 The _-e_ flag accepts one or more _expressions_, each of which must have the following form: