Skip to content

Commit 0d4102f

Browse files
committed
Update README and usage
1 parent fdeab27 commit 0d4102f

File tree

2 files changed

+42
-2
lines changed

2 files changed

+42
-2
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# ipsec-fzf
1+
# lazy-connect
2+
3+
Shell function to fuzzy search an IPSec VPN by name and connect to it automatically.
4+
5+
## Prerequisite
6+
7+
[`fzf`](https://github.com/junegunn/fzf) must be available in the PATH.
8+
9+
## Install
10+
11+
```
12+
git clone https://github.com/arunvelsriram/lazy-connect.git ~/.lazy-connect
13+
```
14+
15+
```
16+
# zsh users
17+
echo "[ -f ~/.lazy-connect/lazy-connect.sh ] && source ~/.lazy-connect/lazy-connect.sh" >> ~/.zshrc
18+
source ~/.zshrc
19+
```
20+
21+
```
22+
# bash users
23+
echo "[ -f ~/.lazy-connect/lazy-connect.sh ] && source ~/.lazy-connect/lazy-connect.sh" >> ~/.bashrc
24+
source ~/.bashrc
25+
```
26+
27+
### Usage
28+
29+
```
30+
lazy-connect - Shell function to fuzzy search an IPSec VPN by name
31+
and connect to it automatically.
32+
33+
-i - Initialize lazy-connect.
34+
Stores the secret and VPN list to ~/.config/lazy-connect/
35+
-h - Show this help
36+
```
37+
38+
### Warning
39+
40+
The secret key to generate TOTP is stored as plain text in `~/.config/lazy-connect/secrete`

lazy-connect.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ function _lazy_connect_usage() {
3939
4040
USAGE:
4141
42-
lazy-connect
42+
lazy-connect - Shell function to fuzzy search an IPSec VPN by name
43+
and connect to it automatically.
4344
4445
-i - Initialize lazy-connect.
4546
Stores the secret and VPN list to ~/.config/lazy-connect/

0 commit comments

Comments
 (0)