Skip to content

Commit dd5c54b

Browse files
committed
docs : Add README.md and logo images
2 parents ebd831c + e9850f8 commit dd5c54b

6 files changed

Lines changed: 60 additions & 0 deletions

File tree

.poggit.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ projects:
55
arrayutils:
66
model: virion
77
type: library
8+
icon: assets/icon.png
89
lint:
910
phpstan: false
1011
...

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<div align="center">
2+
<img src="assets/title.svg"><br>
3+
<h1><img src="https://views.whatilearened.today/views/github/PresentKim/arrayutils.svg?style=for-the-badge" height="24" align="right"></h1><br>
4+
<img src="https://img.shields.io/github/stars/PresentKim/arrayutils?style=for-the-badge" height="24">
5+
<img src="https://img.shields.io/github/license/PresentKim/arrayutils.svg?style=for-the-badge" height="24">
6+
<a href="https://poggit.pmmp.io/ci/PresentKim/arrayutils/~">
7+
<img src="https://poggit.pmmp.io/ci.shield/PresentKim/arrayutils/~?style=for-the-badge" height="24">
8+
</a>
9+
10+
<h1><strong> Library that provides a method to fancy manipulate an array </strong></h1><br>
11+
</div>
12+
13+
## :clipboard: Table of Contents
14+
- [:book: Introduction](#book-introduction)
15+
- [:zap: Features](#zap-features)
16+
- [:file_folder: Target software](#file_folder-target-software)
17+
- [:wrench: Installation](#wrench-installation)
18+
- [:package: Downloads](#package-downloads)
19+
- [:memo: License](#memo-license)
20+
21+
<br>
22+
23+
## :book: Introduction
24+
PHP's array functions are painful for developers. (like `array_map`, `array_filter`)
25+
- Array first or callback function first...
26+
- Return value or reference a variable...
27+
28+
In addition, since it is a `function`, the code breaks every time.
29+
I created this library to solve these problems and make code flow like `js-array`.
30+
31+
<br>
32+
33+
## :zap: Features
34+
You can use `ArrayUtils` to use the features of this library.
35+
- For a detailed description, [Click here (Goto api docs)](https://arrayutils.docs.present.kim/)
36+
37+
<br>
38+
39+
## :file_folder: Target software:
40+
**This is works with [Pocketmine-MP](https://github.com/pmmp/PocketMine-MP)**
41+
42+
<br>
43+
44+
## :wrench: Installation
45+
See [poggit/support/virion](https://github.com/poggit/support/blob/master/virion.md)
46+
47+
<br>
48+
49+
## :package: Downloads:
50+
Download from [Poggit](https://poggit.pmmp.io/ci/PresentKim/arrayutils/~)
51+
52+
<br>
53+
54+
## :memo: License
55+
> You can check out the full license [here](LICENSE)
56+
57+
This project is licensed under the terms of the **MIT** license

assets/icon.png

3.02 KB
Loading

assets/icon.svg

Lines changed: 1 addition & 0 deletions
Loading

assets/title.png

12.6 KB
Loading

0 commit comments

Comments
 (0)