Skip to content

Commit f57806c

Browse files
committed
Update README.md
1 parent b7fe315 commit f57806c

File tree

3 files changed

+79
-7
lines changed

3 files changed

+79
-7
lines changed

.github/workflows/coverage.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: tests
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
test:
10+
runs-on: ubuntu-latest
11+
12+
strategy:
13+
fail-fast: true
14+
matrix:
15+
php: [7.4, 8.0, 8.1]
16+
stability: [ prefer-stable ]
17+
18+
name: PHP ${{ matrix.php }}
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v3
23+
24+
- name: Setup PHP ${{ matrix.php }}
25+
uses: shivammathur/setup-php@v2
26+
with:
27+
php-version: ${{ matrix.php }}
28+
extensions: dom, curl, libxml, mbstring, zip
29+
tools: composer:v2
30+
coverage: xdebug
31+
32+
- name: composer install
33+
run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction
34+
35+
- name: Run tests
36+
run: vendor/bin/phpunit --coverage-clover coverage.xml
37+
38+
- name: Codecov
39+
uses: codecov/codecov-action@v3.1.0
40+
with:
41+
files: ./coverage.xml

LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) 2022 - A2Workspace Team
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,34 @@
1-
# A2Workspace/Laravel-JWT
2-
3-
一個幾乎零配置的 API 認證服務。
4-
5-
此套件是基於 [php-open-source-saver/jwt-auth](https://github.com/PHP-Open-Source-Saver/jwt-auth/) 的包裝,並提供一個簡易的 `AuthenticatesUsers` 特性方便擴充。
1+
<h1 align="center">Laravel-JWT</h1>
2+
<p align="center">
3+
<a href="https://github.com/A2Workspace/laravel-jwt">
4+
<img alt="" src="https://github.com/A2Workspace/laravel-jwt/actions/workflows/coverage.yml/badge.svg">
5+
</a>
6+
<a href="https://github.com/A2Workspace/laravel-jwt">
7+
<img alt="" src="https://img.shields.io/github/workflow/status/A2Workspace/laravel-jwt/tests?style=flat-square">
8+
</a>
9+
<a href="https://codecov.io/gh/A2Workspace/laravel-jwt">
10+
<img alt="" src="https://img.shields.io/codecov/c/github/A2Workspace/laravel-jwt.svg?style=flat-square">
11+
</a>
12+
<a href="https://github.com/A2Workspace/laravel-jwt/blob/master/LICENSE">
13+
<img alt="" src="https://img.shields.io/github/license/A2Workspace/laravel-jwt?style=flat-square">
14+
</a>
15+
<a href="https://packagist.org/packages/a2workspace/laravel-jwt">
16+
<img alt="" src="https://img.shields.io/packagist/v/a2workspace/laravel-jwt.svg?style=flat-square">
17+
</a>
18+
<a href="https://packagist.org/packages/a2workspace/laravel-jwt">
19+
<img alt="" src="https://img.shields.io/packagist/dt/a2workspace/laravel-jwt.svg?style=flat-square">
20+
</a>
21+
</p>
22+
23+
<p>一個幾乎零配置,隨開即用的 API 認證服務。</p>
24+
25+
<br>
26+
27+
此套件是基於 [php-open-source-saver/jwt-auth](https://github.com/PHP-Open-Source-Saver/jwt-auth/) 的包裝,並提供一個簡易的 [AuthenticatesUsers](https://github.com/A2Workspace/laravel-jwt/blob/master/src/AuthenticatesUsers.php) 特性方便擴充。
628

729
特性:
830
- 支援多使用者模型
9-
- 相容 **Nuxt.js**`auth-nuxt`。如何設定請參考 [# Nuxt 登入](#Nuxt-登入)
31+
- 相容 **Nuxt.js**`auth-nuxt`。如何設定請參考 [# Nuxt Supprt](#Nuxt-Supprt)
1032

1133

1234
## 安裝
@@ -251,7 +273,7 @@ Route::get('/auth/user', 'AuthController@me');
251273

252274
-----
253275

254-
## Nuxt 登入
276+
## Nuxt Support
255277

256278
此套件相容於 **Nuxt**`auth-nuxt` 模組中的 `Laravel JWT` ([參考這裡](https://auth.nuxtjs.org/providers/laravel-jwt))。
257279

0 commit comments

Comments
 (0)