Skip to content

Commit

Permalink
Incremented version, updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chill117 committed Jan 31, 2017
1 parent b75cac1 commit e5f9c33
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "proxy-verifier",
"version": "0.3.0",
"version": "0.4.0",
"description": "Check that proxies are working, verify their anonymity level, check for other capabilities such as tunneling and available protocols.",
"keywords": [
"proxy",
Expand Down
24 changes: 23 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ This will install `proxy-verifier` and add it to your application's `package.jso
* [testProtocols](#testprotocols)
* [testAnonymityLevel](#testanonymitylevel)
* [testTunnel](#testtunnel)
* [test](#test)


### testAll
Expand Down Expand Up @@ -250,6 +251,27 @@ Sample `result` when the proxy does not support tunneling:
```


### Test

Use this method to create your custom tests. Example usage:
```js
ProxyVerifier.test(proxy, {
testUrl: 'https://www.google.com/?q=test',
testFn: function(data, status, headers) {

// Check the response data, status, and headers.

// Throw an error if the test failed.
throw new Error('Test failed!');

// Do nothing if the test passed.
}
}, function(error, results) {
// Do something with error or results.
});
```


## Contributing

There are a number of ways you can contribute:
Expand Down Expand Up @@ -280,7 +302,7 @@ grunt test:code-style

## Changelog

* TBD:
* v0.4.0:
* `test()` method to allow for custom tests.
* Deprecated `lookupCountry()`, `loadCountryData()`, and `loadCountryDataSync()`. These will be removed in a future release. Use [geoip-native-lite](https://github.com/chill117/geoip-native-lite) if you need to check the geo-location for your proxies.
* v0.3.0:
Expand Down

0 comments on commit e5f9c33

Please sign in to comment.