Skip to content
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.

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

Added documentation #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ The library provides some proxy setting search strategies to read the proxy sett
* I don't like the Windows DLL and usage of JNI. Replaced both by JNA.

## Usage
### Adding the jar to your build
Add the dependency to your pom.xml
```Xml
<dependency>
<groupId>com.github.markusbernhardt</groupId>
<artifactId>proxy-vole</artifactId>
<version>1.0.5</version>
</dependency>
```
or to you gradle.build:
```
compile 'com.github.markusbernhardt:proxy-vole:1.0.5'
```

### Using the default strategy to find the settings
```Java
Expand Down