aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3a12b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,71 @@
+<!--
+SPDX-FileCopyrightText: 2022 M. Shulhan <ms@kilabit.info>
+
+SPDX-License-Identifier: GPL-3.0-or-later
+-->
+
+# bin.sh
+
+A collection of shell scripts.
+
+## Scripts
+
+**chmod-x.sh**::
+Script to recursively scan directory and remove executable-bit from file that
+may not an executable.
+
+**gen-password.sh**::
+Script to generate random words from Indonesian directory of hunspell.
+
+The hunspell-id package can be installed from AUR:
+https://aur.archlinux.org/packages/hunspell-id-git .
+
+**git-update-all.sh**::
+Script to fetch the latest commits from all git repositories under a
+directory.
+
+**jwt-decode.sh**::
+Script to decode JWT with optional secret to check for signature.
+
+**timer.sh**::
+Script to display message after X duration.
+
+Usage,
+
+ $ timer.sh $TIME [$MESSAGE]
+
+The $TIME parameter is any format that is acceptable by sleep, for example
+60, 1m, 2h.
+The $MESSAGE parameter is optional.
+
+**tmux-session.sh**::
+Script to open new tmux session with start directory based on configuration
+in `~/.tmux.session`.
+
+**wg-activate.sh**::
+Script that activate only one wireguard connection from list of
+configuration in /etc/wireguard/\*.conf or turning off all of them if no
+parameter is given.
+
+## Installation
+
+Clone the repository,
+
+ $ git clone https://git.sr.ht/~shulhan/bin.sh
+
+Go to inside the cloned repository and run
+
+ $ sudo make install
+
+To uninstall it, run
+
+ $ sudo make uninstall
+
+## Development
+
+[Project page](https://kilabit.info/project/bin.sh).
+
+[Changelog](https://git.sr.ht/~shulhan/bin.sh/CHANGELOG.html) - Change log
+for each releases.
+
+[Repository](https://git.sr.ht/~shulhan/bin.sh) - Link to the source code.