Skip to content

Commit c8e4abb

Browse files
committed
Clean up the README
1 parent c7c2b09 commit c8e4abb

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
# alof-lib
2-
[![stable](http://poser.pugx.org/vectorial1024/alof-lib/v)](https://packagist.org/packages/vectorial1024/alof-lib)
3-
![phpunit](https://github.com/vectorial1024/alof-lib/actions/workflows/php.yml/badge.svg)
4-
[![downloads](http://poser.pugx.org/vectorial1024/alof-lib/downloads)](https://packagist.org/packages/vectorial1024/alof-lib)
5-
[![license](http://poser.pugx.org/vectorial1024/alof-lib/license)](https://packagist.org/packages/vectorial1024/alof-lib)
6-
[![php](http://poser.pugx.org/vectorial1024/alof-lib/require/php)](https://packagist.org/packages/vectorial1024/alof-lib)
2+
[![Packagist License][packagist-license-image]][packagist-url]
3+
[![Packagist Version][packagist-version-image]][packagist-url]
4+
[![Packagist Downloads][packagist-downloads-image]][packagist-stats-url]
5+
[![PHP Dependency Version][php-version-image]][packagist-url]
6+
[![GitHub Actions Workflow Status][php-build-status-image]][github-actions-url]
7+
[![GitHub Repo Stars][github-stars-image]][github-repo-url]
78
[![readthedocs](https://readthedocs.org/projects/alof-lib/badge/?version=latest)](https://alof-lib.readthedocs.io/en/latest/?badge=latest)
89

910
(This is a WIP project!)
1011

1112
PHP array-like object functions library ("alof-lib"). Type-hinted functions for array-like objects, just like [those for native arrays](https://www.php.net/manual/en/ref.array.php). Think of this library as a polyfill of those useful functions for array-like objects, so that you may write clean code with array-like objects.
1213

13-
An array-like object ("ALO") is defined to be `implements ArrayAccess` and `implements Traversable`. Examples of array-like objects include:
14+
An array-like object ("ALO") is defined to be `implements ArrayAccess` and `implements Traversable`. Examples include:
1415
- [ArrayObject](https://www.php.net/manual/en/class.arrayobject.php) (since PHP 5)
1516
- [ArrayIterator](https://www.php.net/manual/en/class.arrayiterator.php) (since PHP 5)
1617
- [SplObjectStorage](https://www.php.net/manual/en/class.splobjectstorage.php) (since PHP 5.1)
@@ -65,3 +66,15 @@ assert($keys === [$objKey]); // passes
6566

6667
## Relationship with `transmutation`
6768
This library does the dirty work and ensures the correctness of ALO functions, while `transmutation` provides an easy-to-use API for ALO processing.
69+
70+
[packagist-url]: https://packagist.org/packages/vectorial1024/alof-lib
71+
[packagist-stats-url]: https://packagist.org/packages/vectorial1024/alof-lib/stats
72+
[github-repo-url]: https://github.com/Vectorial1024/alof-lib
73+
[github-actions-url]: https://github.com/Vectorial1024/alof-lib/actions/workflows/php.yml
74+
75+
[packagist-license-image]: https://img.shields.io/packagist/l/vectorial1024/alof-lib?style=plastic
76+
[packagist-version-image]: https://img.shields.io/packagist/v/vectorial1024/alof-lib?style=plastic
77+
[packagist-downloads-image]: https://img.shields.io/packagist/dm/vectorial1024/alof-lib?style=plastic
78+
[php-version-image]: https://img.shields.io/packagist/dependency-v/vectorial1024/alof-lib/php?style=plastic&label=PHP
79+
[php-build-status-image]: https://img.shields.io/github/actions/workflow/status/Vectorial1024/alof-lib/php.yml?style=plastic
80+
[github-stars-image]: https://img.shields.io/github/stars/vectorial1024/alof-lib

0 commit comments

Comments
 (0)