joshtronic/php-projecthoneypot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Preparing for a formal release

Browse source 
Converted tabs to spaces, did some cleanup and updated the composer file.
This commit is contained in:
Josh Sherman 2014-09-17 12:50:54 -04:00
parent c840d5a36f
commit c76fdf936d
5 changed files with 351 additions and 337 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -5,20 +5,16 @@
[![Downloads](http://img.shields.io/packagist/dm/joshtronic/php-projecthoneypot.svg?style=flat)][packagist]
[![Gittip](http://img.shields.io/gittip/joshtronic.svg?style=flat)][gittip]
[travis]: http://travis-ci.org/joshtronic/php-projecthoneypot
[coveralls]: https://coveralls.io/r/joshtronic/php-projecthoneypot
[packagist]: https://packagist.org/packages/joshtronic/php-projecthoneypot
[gittip]: https://www.gittip.com/joshtronic/
PHP Wrapper for Project Honey Pot. Compatible with PHP 5.3+ and HHVM.
## Installation
The preferred installation method is via `composer`. First add the following to your `composer.json`
The preferred installation method is via `composer`. First add the following
to your `composer.json`
```json
"require": {
"joshtronic/php-projecthoneypot": "dev-master"
"joshtronic/php-projecthoneypot": "dev-master"
}
```
@ -42,11 +38,14 @@ print_r($results);
### Results
Queries will return an array of information about the IP address. The array will contain `last_activity`, `threat_score` and an array of `categories`.
Queries will return an array of information about the IP address. The array
will contain `last_activity`, `threat_score` and an array of `categories`.
### Simulating Results
The folks at Project Honey Pot were kind enough to include a way to simulate results from their http:BL API. You can do so by performing queries against the following IP addresses.
The folks at Project Honey Pot were kind enough to include a way to simulate
results from their http:BL API. You can do so by performing queries against
the following IP addresses.
#### Visitor Types
@ -75,10 +74,21 @@ The folks at Project Honey Pot were kind enough to include a way to simulate res
## Contributing
Suggestions and bug reports are always welcome, but karma points are earned for pull requests.
Suggestions and bug reports are always welcome, but karma points are earned
for pull requests.
Unit tests are required for all contributions. You can run the test suite from the `tests` directory simply by running `phpunit .`
Unit tests are required for all contributions. You can run the test suite from
the `tests` directory simply by running `phpunit .`
I also urge you to install a honey pot and donate some MX records to Project Honey Pot. They are doing great work, they provide http:BL as a free service and your donations help make their service ever better!
I also urge you to install a honey pot and donate some MX records to Project
Honey Pot. They are doing great work, they provide http:BL as a free service
and your donations help make their service ever better!
If you’re not already a member, please sign up today with [my referral code](http://www.projecthoneypot.org?rf=123193).
If you’re not already a member, please sign up today with
[my referral code][referral].
[coveralls]: https://coveralls.io/r/joshtronic/php-projecthoneypot
[gittip]: https://www.gittip.com/joshtronic/
[packagist]: https://packagist.org/packages/joshtronic/php-projecthoneypot
[referral]: http://www.projecthoneypot.org?rf=123193
[travis]: http://travis-ci.org/joshtronic/php-projecthoneypot