Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
escalate committed Feb 7, 2021
1 parent 5158e08 commit b387951
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# oh-my-zsh proxy plugin

Aliases and functions to manage proxy shell environment settings
An [oh-my-zsh](https://ohmyz.sh) plugin to manage proxy shell environment settings.

## Installation

Clone plugin
Clone repository into oh-my-zsh custom plugins directory
```bash
$ git clone https://github.com/escalate/oh-my-zsh-proxy-plugin.git "$(HOME)/.oh-my-zsh/custom/plugins/proxy"
```

Enable plugin in ~/.zshrc
Enable proxy plugin in ~/.zshrc configuration
```
plugins=(proxy)
```
Expand All @@ -24,6 +24,8 @@ Proxy settings can be configured inside the following files:
* ~/.proxy/rsync_proxy
* ~/.proxy/no_proxy

Only the value of the corresponding environment variable must be stored in the files.

## Usage

### Enable proxy settings
Expand Down

0 comments on commit b387951

Please sign in to comment.