Skip to content

Commit 72f2489

Browse files
committed
docs: updated readme
1 parent 6412937 commit 72f2489

File tree

2 files changed

+37
-2
lines changed

2 files changed

+37
-2
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
# Bash dot Dee
22

3+
## TLDR;
4+
5+
curl -o - https://raw.githubusercontent.com/tobybatch/bashdotdee/refs/heads/main/install.sh | bash
6+
7+
## Manual install
8+
39
Adds function to my bash shell.
410

511
git clone https://github.com/tobybatch/bashdotdee.git $HOME/.bash.d
6-
12+
713
cat <<EOF>>.bashrc
814
PATH=\$PATH:\$HOME/.bash.d/bin
915
for x in ~/.bash.d/enabled/*.bash
@@ -16,3 +22,32 @@ Now use ```bash.d.sh -h``` to manage extensions.
1622

1723
New shells should now have added juice.
1824

25+
## Usage
26+
27+
After installing open an new shell.
28+
29+
### Shou usage
30+
31+
bash.d.sh -h
32+
33+
### List modules
34+
35+
bash.d.sh -l
36+
37+
### Enable a module
38+
39+
bash.d.sh -e <MODULE_NAME>
40+
41+
### Disable a module
42+
43+
bash.d.sh -d <MODULE_NAME>
44+
45+
### Examples
46+
47+
Enable batcat
48+
49+
bash.d.sh -e 11_batcat.bash
50+
51+
Disable python
52+
53+
bash.d.sh -d 14_python.bash

install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/bin/bash
22

3-
TARGET=/tmp
3+
TARGET=$HOME
44

55
if [ ! -d "$TARGET/.bash.d" ]; then
66
git clone https://github.com/tobybatch/bashdotdee.git $TARGET/.bash.d

0 commit comments

Comments
 (0)