Skip to content

Commit 2751f63

Browse files
committed
Updating README
1 parent dc368c0 commit 2751f63

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ PHP BitArray
1111

1212
BitArray for PHP.
1313

14+
This project manipulates compact array of bit values stored internally as strings.
15+
16+
The bit arrays may have variable length specified when an object is created using either:
17+
18+
* a specific size;
19+
* a traversable collection;
20+
* a string representation of bits;
21+
* a json representation of bits;
22+
* a slice from another bit array;
23+
* a concatenation from two others bit arrays.
24+
25+
The project provides methods to get and set bits values using PHP natural syntax as well as the iterator facility offered by PHP foreach language construct.
26+
It also provides methods for bitwise logical operations between two bit arrays `and`, `or`, `xor` and also `not` operation.
27+
1428
This project uses:
1529

1630
* [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer) for checking PHP code style using [Joomla Coding Standards](https://github.com/joomla/coding-standards)

0 commit comments

Comments
 (0)