Skip to content

Update README.md with installation instructions #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2018
Merged

Update README.md with installation instructions #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,18 @@ brew install oath-toolkit fzf

## Install

```
git clone https://github.com/arunvelsriram/lazy-connect.git ~/.lazy-connect
```
### Using Homebrew

```
# zsh users
echo "[ -f ~/.lazy-connect/lazy-connect.sh ] && source ~/.lazy-connect/lazy-connect.sh" >> ~/.zshrc
source ~/.zshrc
brew tap arunvelsriram/stable
brew install lazy-connect
```

### Manual

```
# bash users
echo "[ -f ~/.lazy-connect/lazy-connect.sh ] && source ~/.lazy-connect/lazy-connect.sh" >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/arunvelsriram/lazy-connect.git ~/.lazy-connect
sudo ln -s ~/.lazy-connect/lazy-connect /usr/local/bin/lazy-connect
```

### Usage
Expand Down Expand Up @@ -56,8 +54,8 @@ export LAZY_CONNECT_TOTP_QUERY=<name of the issuer>

### Note

* The secret key to generate TOTP is stored in Keychain on Mac under default `login` keychain. You may need to
- The secret key to generate TOTP is stored in Keychain on Mac under default `login` keychain. You may need to
enter your login password to allow access to Keychain.
* You need to add your Termainal emulator app that invokes the function to `Security & Privacy -> Accessibility`. It is
- You need to add your Termainal emulator app that invokes the function to `Security & Privacy -> Accessibility`. It is
necesssary because the script interacts with the UI. There are other ways via CLI to avoid UI interaction but
they are all broken in OS X 10.12+.