Skip to content

Commit be7633a

Browse files
committed
docs: enhance README.md with project details and badges
1 parent f45e71d commit be7633a

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,44 @@
1-
# github-project-php
1+
# github-project-php 👋
2+
3+
<p align="center">
4+
<a href="#"><img src="https://img.shields.io/github/license/cslant/github-project-php.svg?style=flat-square" alt="License"></a>
5+
<a href="https://github.com/cslant/github-project-php/releases"><img src="https://img.shields.io/github/release/cslant/github-project-php.svg?style=flat-square" alt="Latest Version"></a>
6+
<a href="https://packagist.org/packages/cslant/github-project-php"><img src="https://img.shields.io/packagist/dt/cslant/github-project-php.svg?style=flat-square" alt="Total Downloads"></a>
7+
<a href="https://github.com/cslant/github-project-php/actions/workflows/setup_test.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/github-project-php/setup_test.yml?label=tests&branch=main" alt="Test Status"></a>
8+
<a href="https://github.com/cslant/github-project-php/actions/workflows/php-cs-fixer.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/github-project-php/php-cs-fixer.yml?label=code%20style&branch=main" alt="Code Style Status"></a>
9+
10+
## 📝 Introduction
11+
12+
GitHub Project PHP is a package that helps you manage your Github projects in PHP.
13+
14+
It provides a simple and easy-to-use webhooks system to get the GitHub project's actions and implement comments on all activities in the project.
15+
16+
## 📋 Requirements
17+
18+
- PHP ^8.3
19+
- [Composer](https://getcomposer.org/)
20+
- [Laravel](https://laravel.com/) ^10.0
21+
22+
## 🔧 Installation
23+
24+
You can install this package via Composer:
25+
26+
```bash
27+
composer require cslant/github-project-php
28+
```
29+
30+
## 🚀 Usage
31+
32+
See the [Usage - GitHub Project PHP Documentation](https://docs.cslant.com/github-project-php/usage)
33+
for a list of usage.
34+
35+
Please check and update some configurations in the documentation.
36+
37+
## 📖 Official Documentation
38+
39+
Please see the [GitHub Project PHP Documentation](https://docs.cslant.com/github-project-php) for more
40+
information.
41+
42+
## License
43+
44+
The MIT License (MIT). Please see [License File](LICENSE) for more information.

0 commit comments

Comments
 (0)