diff --git a/README.org b/README.org new file mode 100644 index 0000000..bf9f8a9 --- /dev/null +++ b/README.org @@ -0,0 +1,27 @@ +* Bash Scripts + +This repository is an assortment of my various bash scripts. I've created it largely as a way to organize my many scripts such that they can be easily accessed without having to search through directories to find them. + +Some example commands you can run to get started: +#+begin_src bash +git clone https://git.randomctf.com/random936/bash-scripts +source bash-scripts/aliases.sh +#+end_src + +** Example Usage + +Running the example command below: +#+begin_src bash +echo test stdin | run hello world from terminal +#+end_src + +Returns the following results: +#+begin_src +Hello world! +Got CLI arguments: +1: from +2: terminal +Recieved stdin: +test stdin +#+end_src +