Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
secondtruth committed May 16, 2024
1 parent bc3b958 commit d9a6e61
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Gatekeeper

[![Build Status](https://img.shields.io/travis/secondtruth/gatekeeper.svg)](https://travis-ci.org/secondtruth/gatekeeper)
[![Build Status](https://img.shields.io/github/actions/workflow/status/secondtruth/gatekeeper/tests.yml)](https://github.com/secondtruth/gatekeeper/actions/workflows/tests.yml)
[![Scrutinizer](http://img.shields.io/scrutinizer/g/secondtruth/gatekeeper.svg)](https://scrutinizer-ci.com/g/secondtruth/gatekeeper)
[![Coverage](http://img.shields.io/scrutinizer/coverage/g/secondtruth/gatekeeper.svg)](https://scrutinizer-ci.com/g/secondtruth/gatekeeper)
[![License](http://img.shields.io/packagist/l/secondtruth/gatekeeper.svg)](https://packagist.org/packages/secondtruth/gatekeeper)
[![Coverage](https://img.shields.io/codecov/c/gh/secondtruth/gatekeeper?token=pmX6z4UHDJ)](https://codecov.io/gh/secondtruth/gatekeeper)
[![License](https://img.shields.io/github/license/secondtruth/gatekeeper.svg?color=blue)](https://packagist.org/packages/secondtruth/gatekeeper)

The Gatekeeper library protects websites from spam and other attacks. It prevents bad bots from delivering their junk, and in many cases,
from ever reading your site in the first place.


## Description

Welcome to a whole new way of keeping your service, forum, wiki or content management system free of spam and other attacks.
Expand All @@ -24,7 +23,6 @@ Whenever possible, you should run it in combination with a more traditional spam

The library is inspired by the **Bad Behavior** anti-spam system by **Michael Hampton**.


## Usage

Include the vendor autoloader and use the classes:
Expand Down Expand Up @@ -65,7 +63,6 @@ $gatekeeper->addACL(new IPAddressACL($allowed, $denied));
$gatekeeper->run($request, $screener);
```


## Installation

### Install via Composer
Expand All @@ -74,13 +71,13 @@ $gatekeeper->run($request, $screener);

To install the library, run the following command and you will get the latest development version:

$ php composer.phar require secondtruth/gatekeeper:dev-master

```bash
composer require secondtruth/gatekeeper:dev-master
```

## Requirements

* You must have at least PHP version 8.1 installed on your system.

- You must have at least PHP version 8.1 installed on your system.

## Author, Credits and License

Expand All @@ -91,4 +88,4 @@ Based on the work of:

* Michael Hampton

Thanks to [all other Contributors](https://github.com/secondtruth/wumbo/graphs/contributors)!
Thanks to [all other contributors](https://github.com/secondtruth/wumbo/graphs/contributors)!

0 comments on commit d9a6e61

Please sign in to comment.