|
1 | | -# Laravel Sendy is a simple and clean wrapper for the Sendy API, making it easy to manage subscribers, lists, and campaigns directly from your Laravel application. |
2 | | - |
3 | | -[](https://packagist.org/packages/coderflexx/laravel-sendy) |
4 | | -[](https://github.com/coderflexx/laravel-sendy/actions?query=workflow%3Arun-tests+branch%3Amain) |
5 | | -[](https://github.com/coderflexx/laravel-sendy/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) |
6 | | -[](https://packagist.org/packages/coderflexx/laravel-sendy) |
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/laravel-sendy.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-sendy) |
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 coderflexx/laravel-sendy |
24 | | -``` |
25 | | - |
26 | | -You can publish and run the migrations with: |
27 | | - |
28 | | -```bash |
29 | | -php artisan vendor:publish --tag="laravel-sendy-migrations" |
30 | | -php artisan migrate |
31 | | -``` |
32 | | - |
33 | | -You can publish the config file with: |
34 | | - |
35 | | -```bash |
36 | | -php artisan vendor:publish --tag="laravel-sendy-config" |
37 | | -``` |
38 | | - |
39 | | -This is the contents of the published config file: |
40 | | - |
41 | | -```php |
42 | | -return [ |
43 | | -]; |
44 | | -``` |
45 | | - |
46 | | -Optionally, you can publish the views using |
47 | | - |
48 | | -```bash |
49 | | -php artisan vendor:publish --tag="laravel-sendy-views" |
50 | | -``` |
51 | | - |
52 | | -## Usage |
53 | | - |
54 | | -```php |
55 | | -$laravelSendy = new Coderflex\LaravelSendy(); |
56 | | -echo $laravelSendy->echoPhrase('Hello, Coderflex!'); |
57 | | -``` |
58 | | - |
59 | | -## Testing |
60 | | - |
61 | | -```bash |
62 | | -composer test |
63 | | -``` |
64 | | - |
65 | | -## Changelog |
66 | | - |
67 | | -Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. |
68 | | - |
69 | | -## Contributing |
70 | | - |
71 | | -Please see [CONTRIBUTING](CONTRIBUTING.md) for details. |
72 | | - |
73 | | -## Security Vulnerabilities |
74 | | - |
75 | | -Please review [our security policy](../../security/policy) on how to report security vulnerabilities. |
76 | | - |
77 | | -## Credits |
78 | | - |
79 | | -- [Oussama](https://github.com/ousid) |
80 | | -- [All Contributors](../../contributors) |
81 | | - |
82 | | -## License |
83 | | - |
84 | | -The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |
| 1 | +### WIP |
| 2 | +This package is __WIP__, please do not use it in a production project yet. |
0 commit comments