Skip to content

Commit cd86538

Browse files
committed
Update documentation
1 parent c9af44b commit cd86538

File tree

1 file changed

+13
-29
lines changed

1 file changed

+13
-29
lines changed

README.md

Lines changed: 13 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
**Laravel Subscriptions** is a flexible plans and subscription management system for Laravel, with the required tools to run your SAAS like services efficiently. It's simple architecture, accompanied by powerful underlying to afford solid platform for your business.
44

55
[![Packagist](https://img.shields.io/packagist/v/rinvex/laravel-subscriptions.svg?label=Packagist&style=flat-square)](https://packagist.org/packages/rinvex/laravel-subscriptions)
6-
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/rinvex/laravel-subscriptions.svg?label=Scrutinizer&style=flat-square)](https://scrutinizer-ci.com/g/rinvex/laravel-subscriptions/)
7-
[![Travis](https://img.shields.io/travis/rinvex/laravel-subscriptions.svg?label=TravisCI&style=flat-square)](https://travis-ci.org/rinvex/laravel-subscriptions)
8-
[![StyleCI](https://styleci.io/repos/93313402/shield)](https://styleci.io/repos/93313402)
96
[![License](https://img.shields.io/packagist/l/rinvex/laravel-subscriptions.svg?label=License&style=flat-square)](https://github.com/rinvex/laravel-subscriptions/blob/develop/LICENSE)
107

118

@@ -24,7 +21,7 @@
2421

2522
2. Publish resources (migrations and config files):
2623
```shell
27-
php artisan publish:subscriptions
24+
php artisan publish:laravel-subscriptions
2825
```
2926

3027
3. Execute migrations via the following command:
@@ -288,28 +285,15 @@ $subscriptions = app('rinvex.subscriptions.plan_subscription')->findEndedPeriod(
288285
289286
### Models
290287
291-
**Rinvex Subscriptions** uses 4 models:
288+
**Laravel Subscriptions** uses 4 models:
292289
293290
```php
294-
Rinvex\Subscriptions\Models\Plan;
295-
Rinvex\Subscriptions\Models\PlanFeature;
296-
Rinvex\Subscriptions\Models\PlanSubscription;
297-
Rinvex\Subscriptions\Models\PlanSubscriptionUsage;
291+
Laravelcm\Subscriptions\Models\Plan;
292+
Laravelcm\Subscriptions\Models\Feature;
293+
Laravelcm\Subscriptions\Models\Subscription;
294+
Laravelcm\Subscriptions\Models\SubscriptionUsage;
298295
```
299296
300-
301-
## Roadmap
302-
303-
**Looking for contributors!**
304-
305-
The following are a set of limitations to be improved, or feature requests that's looking for contributors to implement, all PRs are welcome 🙂
306-
307-
- [ ] Allow paying for multiple occurrences of the same plan (i.e. monthly plan, user can pay for 6 months of that plan) (#64)
308-
- [ ] Plan prorate fields in database isn't utilized, this should be implemented to consolidate extension dates, and prices (#68)
309-
- [ ] Change *features* to be in a many-to-many relationship with plans. Multiple plans can have the same feature, and many plans can have many features as well (#101)
310-
- [ ] Plan subscription timezone field in database isn't utilized, this should be implemented to respect timezone on date calculations (i.e. starts_at, ends_at, trial_ends_at) (#78)
311-
- [ ] Separate trial feature from the subscription periods and adjust subscriptions accordingly. Users should be able to have a trial period without having a subscription at all (#67)
312-
313297
## Changelog
314298
315299
Refer to the [Changelog](CHANGELOG.md) for a full history of the project.
@@ -319,9 +303,9 @@ Refer to the [Changelog](CHANGELOG.md) for a full history of the project.
319303
320304
The following support channels are available at your fingertips:
321305
322-
- [Chat on Slack](https://bit.ly/rinvex-slack)
323-
- [Help on Email](mailto:help@rinvex.com)
324-
- [Follow on Twitter](https://twitter.com/rinvex)
306+
- [Chat on Telegram](https://laravel.cm/telegram)
307+
- [Help on Email](mailto:developers@laravel.cm)
308+
- [Follow on Twitter](https://twitter.com/laravelcm)
325309
326310
327311
## Contributing & Protocols
@@ -339,16 +323,16 @@ Bug reports, feature requests, and pull requests are very welcome.
339323
340324
## Security Vulnerabilities
341325
342-
If you discover a security vulnerability within this project, please send an e-mail to [help@rinvex.com](help@rinvex.com). All security vulnerabilities will be promptly addressed.
326+
If you discover a security vulnerability within this project, please send an e-mail to [developers@laravel.cm](help@rinvex.com). All security vulnerabilities will be promptly addressed.
343327
344328
345-
## About Rinvex
329+
## About Laravel Cameroon
346330
347-
Rinvex is a software solutions startup, specialized in integrated enterprise solutions for SMEs established in Alexandria, Egypt since June 2016. We believe that our drive The Value, The Reach, and The Impact is what differentiates us and unleash the endless possibilities of our philosophy through the power of software. We like to call it Innovation At The Speed Of Life. That’s how we do our share of advancing humanity.
331+
The community of PHP and Laravel developers in Cameroon, the largest gathering of developers in Cameroon.
348332
349333
350334
## License
351335
352336
This software is released under [The MIT License (MIT)](LICENSE).
353337
354-
(c) 2016-2022 Rinvex LLC, Some rights reserved.
338+
(c) 2018-2023 Laravel Cameroun, Some rights reserved.

0 commit comments

Comments
 (0)