Skip to content

Commit ca2915e

Browse files
committed
docs: update README to clarify package features and multi-tenancy support
1 parent b365582 commit ca2915e

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# laravel-setanjo - Multi-Tenant Laravel Settings Package
1+
# laravel-setanjo - Laravel Settings Package with Multi-Tenant Support
22

33
<p align="center">
44
<a href="https://github.com/ahs12/laravel-setanjo/actions"><img src="https://github.com/ahs12/laravel-setanjo/actions/workflows/run-tests.yml/badge.svg" alt="Build Status"></a>
@@ -7,16 +7,18 @@
77
<a href="https://packagist.org/packages/ahs12/laravel-setanjo"><img src="https://img.shields.io/packagist/l/ahs12/laravel-setanjo" alt="License"></a>
88
</p>
99

10-
A powerful Laravel package for managing application settings with multi-tenant support. Store global settings or tenant-specific configurations with automatic type casting, caching, and a clean API. Perfect for A/B testing, feature flags, and user preferences.
10+
A powerful Laravel package for managing application settings and configurations. Store global application settings or model-specific configurations (user preferences, company settings, etc.) with automatic type casting, caching, and a clean API. Perfect for feature flags, A/B testing, user preferences, and dynamic configuration management.
11+
12+
**Note**: This package does **not** provide multi-tenancy features for your application. However, if your Laravel project already has multi-tenancy implemented, this package can store tenant-specific settings alongside your existing tenant architecture.
1113

1214
## Features
1315

14-
- 🏢 **Multi-Tenant Support**: Both strict and polymorphic tenancy modes
15-
- 🗃️ **Polymorphic Storage**: Store settings for any model type
16-
- 🏛️ **Global Settings**: Settings without any tenant scope
16+
- 🏢 **Multi-Tenant Ready**: Works with existing multi-tenant applications
17+
- 🗃️ **Model-Specific Settings**: Store settings for any Eloquent model (User, Company, etc.)
18+
- 🏛️ **Global Settings**: Application-wide settings without model scope
1719
-**Caching**: Optional caching with configurable cache store
18-
- 🔒 **Validation**: Validate tenant models and prevent unauthorized access
19-
- 📦 **Clean API**: Simple, intuitive API inspired by popular packages
20+
- 🔒 **Validation**: Validate models and prevent unauthorized access
21+
- 📦 **Clean API**: Simple, intuitive API for setting and retrieving values
2022
- 🧪 **Fully Tested**: Comprehensive test suite included
2123
-**Type Safety**: Automatic type detection and conversion
2224

0 commit comments

Comments
 (0)