Skip to content

Commit bd97037

Browse files
committed
update readme
1 parent 4a97f27 commit bd97037

File tree

1 file changed

+3
-61
lines changed

1 file changed

+3
-61
lines changed

README.md

Lines changed: 3 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,6 @@
1-
# ozu Client
1+
# Client companion for Ozu
22

3-
[![Latest Version on Packagist](https://img.shields.io/packagist/v/code16/ozu-client.svg?style=flat-square)](https://packagist.org/packages/code16/ozu-client)
4-
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/code16/ozu-client/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/code16/ozu-client/actions?query=workflow%3Arun-tests+branch%3Amain)
5-
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/code16/ozu-client/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/code16/ozu-client/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
6-
[![Total Downloads](https://img.shields.io/packagist/dt/code16/ozu-client.svg?style=flat-square)](https://packagist.org/packages/code16/ozu-client)
3+
Ozu brings a nice solution to develop and maintain a static website with a dynamic content, keeping the productivity and great DX of Laravel.
74

8-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
5+
The project is in private beta for now, but you can request an access on [its website](https://ozu.code16.fr). You can refer to this blog post to learn more about the project: [https://code16.fr/blog/en/ozu-static-websites-laravel/](https://code16.fr/blog/en/ozu-static-websites-laravel/)
96

10-
## Support us
11-
12-
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/ozu Client.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/ozu Client)
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).
17-
18-
## Installation
19-
20-
You can install the package via composer:
21-
22-
```bash
23-
composer require code16/ozu-client
24-
```
25-
26-
You can publish the config file with:
27-
28-
```bash
29-
php artisan vendor:publish --tag="ozu-client-config"
30-
```
31-
32-
This is the contents of the published config file:
33-
34-
```php
35-
return [
36-
];
37-
```
38-
39-
## Testing
40-
41-
```bash
42-
composer test
43-
```
44-
45-
## Changelog
46-
47-
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
48-
49-
## Contributing
50-
51-
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
52-
53-
## Security Vulnerabilities
54-
55-
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
56-
57-
## Credits
58-
59-
- [Code 16](https://github.com/code16)
60-
- [All Contributors](../../contributors)
61-
62-
## License
63-
64-
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)