Skip to content
This repository has been archived by the owner on Aug 13, 2023. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: NanoSector <rick@nanosector.nl>
  • Loading branch information
NanoSector committed Apr 27, 2019
1 parent 21dbe29 commit 3cf24bc
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Command parsing library for WildPHP
----------
# Queue library for WildPHP
[![Build Status](https://scrutinizer-ci.com/g/WildPHP/queue/badges/build.png)](https://scrutinizer-ci.com/g/WildPHP/queue/build-status/master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/WildPHP/queue/badges/quality-score.png)](https://scrutinizer-ci.com/g/WildPHP/queue/?branch=master)
[![Scrutinizer Code Coverage](https://scrutinizer-ci.com/g/WildPHP/queue/badges/coverage.png)](https://scrutinizer-ci.com/g/WildPHP/queue/code-structure/master/code-coverage)
Expand All @@ -8,8 +7,14 @@
[![Total Downloads](https://poser.pugx.org/wildphp/queue/downloads)](https://packagist.org/packages/wildphp/queue)


This library aims at making command parsing easy. Not only does it parse strings into commands and parameters, it allows
you to define restrictions to parameters (so-called strategies) and do automatic type/content validation.
This library defines a simple (message) queue interface. It sends out messages in the order they came in, but at a limited rate.

Currently implemented features are:
- Basic queue functionality
- Callback queue items
- Burst mode (send a batch of messages before throttling)

The default values are to send 1 message per second with a burst rate of 5 messages. This suits IRC well.

## Installation
To install this library, you will need [Composer](https://getcomposer.org/).
Expand Down

0 comments on commit 3cf24bc

Please sign in to comment.