From 3ef750ae212283f154bbd8130feb53e992fddd97 Mon Sep 17 00:00:00 2001 From: SillyPill Date: Sun, 24 Oct 2021 17:35:20 +0530 Subject: [PATCH] Updated readme .gitignore --- .gitignore | 1 + README.md | 30 +++++++++++++++++++++++++++++- 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 5e777da..8905467 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ *.o +river-shifttags xdg-shell.h xdg-shell.c river-status-unstable-v1.h diff --git a/README.md b/README.md index 2dd227f..c70b492 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,32 @@ -# river-shifttag +# river-shifttags A tool for the river Wayland compositor that will calculate the rotated tags from the currently focused tags. + +# Installation + +``` +$ make +# make install +``` + +# Usage + +To rotate the currently focused once to the right +``` +river-shifttags +``` + +To rotate the currently focused once to the left +``` +river-shifttags --shifts -1 +``` + +To rotate a different number of tags +``` +river-shifttags --num-tags 16 +``` + +# License + +GPLv3