Skip to content

Commit c820cf9

Browse files
committed
Update README.md
1 parent 2c708f7 commit c820cf9

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

+42
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,45 @@
77
[![Total Downloads](https://img.shields.io/packagist/dt/binafy/laravel-score.svg?style=flat-square)](https://packagist.org/packages/binafy/laravel-score)
88
[![License](https://img.shields.io/packagist/l/binafy/laravel-score)](https://packagist.org/packages/binafy/laravel-score)
99
[![Passed Tests](https://github.com/binafy/laravel-score/actions/workflows/tests.yml/badge.svg)](https://github.com/binafy/laravel-score/actions/workflows/tests.yml)
10+
11+
## Introduction
12+
13+
A comprehensive Laravel package to implement scoring systems effortlessly. Whether you're building leaderboards, calculating performance metrics, or managing gamification features, Laravel Score provides an intuitive API to define, calculate, and manage scores seamlessly. Perfect for applications requiring dynamic and flexible scoring mechanisms.
14+
15+
## Key Features:
16+
17+
- Simple integration with Eloquent models.
18+
- Support for customizable scoring rules.
19+
- Designed for performance and scalability.
20+
- Extensible and developer-friendly.
21+
22+
## Installation
23+
24+
You can install the package with Composer.
25+
26+
```shell
27+
composer require binafy/laravel-score
28+
```
29+
30+
## Publish
31+
32+
If you want to publish a config file you can use this command:
33+
34+
```shell
35+
php artisan vendor:publish --tag="laravel-score-config"
36+
```
37+
38+
If you want to publish the migrations you can use this command:
39+
40+
```shell
41+
php artisan vendor:publish --tag="laravel-score-migrations"
42+
```
43+
44+
For convenience, you can use this command to publish config, migration, and ... files:
45+
46+
```shell
47+
php artisan vendor:publish --provider="Binafy\LaravelScore\Providers\LaravelScoreServiceProvider"
48+
```
49+
50+
After publishing, run the `php artisan migrate` command.
51+

0 commit comments

Comments
 (0)