Skip to content

Commit 7b71a0b

Browse files
committed
Updated read me
1 parent acb54d6 commit 7b71a0b

File tree

1 file changed

+10
-49
lines changed

1 file changed

+10
-49
lines changed

README.md

Lines changed: 10 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
1-
# Frontend package for spatie permissions package
1+
# Frontend Boilerplate for spatie permissions package
22

3-
[![Latest Version on Packagist](https://img.shields.io/packagist/v/webdevhayes/laravel-spatie-permissions-frontend.svg?style=flat-square)](https://packagist.org/packages/webdevhayes/laravel-spatie-permissions-frontend)
4-
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/webdevhayes/laravel-spatie-permissions-frontend/run-tests?label=tests)](https://github.com/webdevhayes/laravel-spatie-permissions-frontend/actions?query=workflow%3ATests+branch%3Amaster)
5-
[![Total Downloads](https://img.shields.io/packagist/dt/webdevhayes/laravel-spatie-permissions-frontend.svg?style=flat-square)](https://packagist.org/packages/webdevhayes/laravel-spatie-permissions-frontend)
6-
7-
8-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
9-
10-
## Support us
11-
12-
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/package-laravel-spatie-permissions-frontend-laravel.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/package-laravel-spatie-permissions-frontend-laravel)
13-
14-
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
15-
16-
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
3+
Frontend bolierplate for spaties permissions package. This package gives you a start on managing roles and permissions.
174

185
## Installation
196

@@ -23,54 +10,28 @@ You can install the package via composer:
2310
composer require webdevhayes/laravel-spatie-permissions-frontend
2411
```
2512

26-
You can publish and run the migrations with:
13+
## Usage
2714

28-
```bash
29-
php artisan vendor:publish --provider="Webdevhayes\LaravelSpatiePermissionsFrontend\LaravelSpatiePermissionsFrontendServiceProvider" --tag="migrations"
30-
php artisan migrate
31-
```
15+
You can publish all routes,views and controller. You have the option to publish bootstrap frontend or tailwind frontend.
3216

33-
You can publish the config file with:
17+
Bootstrap
3418
```bash
35-
php artisan vendor:publish --provider="Webdevhayes\LaravelSpatiePermissionsFrontend\LaravelSpatiePermissionsFrontendServiceProvider" --tag="config"
36-
```
37-
38-
This is the contents of the published config file:
39-
40-
```php
41-
return [
42-
];
43-
```
44-
45-
## Usage
46-
47-
```php
48-
$laravel-spatie-permissions-frontend = new Webdevhayes\LaravelSpatiePermissionsFrontend();
49-
echo $laravel-spatie-permissions-frontend->echoPhrase('Hello, Webdevhayes!');
19+
php artisan laravel-spatie-permissions-frontend bootstrap
5020
```
51-
52-
## Testing
53-
21+
Tailwind
5422
```bash
55-
composer test
23+
php artisan laravel-spatie-permissions-frontend tailwind
5624
```
5725

5826
## Changelog
5927

6028
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
6129

62-
## Contributing
63-
64-
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
65-
66-
## Security Vulnerabilities
67-
68-
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
69-
7030
## Credits
7131

7232
- [James](https://github.com/webdevhayes)
73-
- [All Contributors](../../contributors)
33+
- [Spatie](https://spatie.be/open-source)
34+
- [Laravel: Most of this package came from the laravel UI and credit goes to them to help inspire me for this package](https://github.com/laravel/ui)
7435

7536
## License
7637

0 commit comments

Comments
 (0)