feat: Enhance documentation across all packages with detailed features, installation instructions, and usage examples

Author: Smilefounder

README.md

@@ -1,23 +1,80 @@
 # Mixcore JavaScript SDK
 
-This monorepo contains modular, framework-agnostic packages for Mixcore projects.
+![Mixcore Logo](https://mixcore.net/images/logo.svg)
+
+Modular, framework-agnostic SDK for Mixcore projects. Built with TypeScript and distributed as ESM/CJS modules.
+
+## Features
+
+- **Modular architecture**: Import only what you need
+- **TypeScript-first**: Full type safety and autocompletion
+- **Framework-agnostic**: Works with any JavaScript framework
+- **Production-ready**: Well-tested and documented
 
 ## Packages
 
-- **@mixcore/shared**: Utilities, helpers, constants
-- **@mixcore/base**: Base classes, abstract models, interfaces
-- **@mixcore/apis**: API clients, endpoint wrappers, schema types
+| Package | Description |
+|--------|-------------|
+| [@mixcore/shared](packages/shared) | Shared utilities, helpers and constants |
+| [@mixcore/base](packages/base) | Base classes, abstract models and interfaces |
+| [@mixcore/api](packages/api) | API clients and endpoint wrappers |
+| [@mixcore/config](packages/config) | Configuration management |
+| [@mixcore/database](packages/database) | Database domain services |
+| [@mixcore/file](packages/file) | File handling utilities |
+| [@mixcore/user](packages/user) | User/auth services |
+| [@mixcore/template](packages/template) | Template rendering services |
 
 ## Getting Started
 
-Each package contains its own README with usage examples. See `/packages/*/README.md` for details.
+### Installation
+
+```bash
+npm install @mixcore/api @mixcore/database # or whichever packages you need
+```
+
+### Usage Example
+
+```typescript
+import { ApiService } from '@mixcore/api';
+import { ModuleDataService } from '@mixcore/database';
+
+const api = new ApiService({ apiBaseUrl: 'https://api.mixcore.net' });
+const dataService = new ModuleDataService({ api });
+
+// Use services...
+```
 
 ## Development
 
-- All code is TypeScript-first.
-- Build outputs: ESM, CJS, and type declarations.
-- Tests: Run `npm test` or `yarn test` from the root.
+### Prerequisites
+
+- Node.js 18+
+- pnpm
+
+### Setup
+
+```bash
+git clone https://github.com/mixcore/javascript-sdk.git
+cd javascript-sdk
+pnpm install
+```
+
+### Building
+
+```bash
+pnpm build
+```
+
+### Testing
+
+```bash
+pnpm test
+```
+
+## Contributing
+
+Contributions welcome! Please see our [Contribution Guidelines](CONTRIBUTING.md).
 
 ## License
 
-Mixcore Community License (MCL) or compatible OSS license. See LICENSE file for details.
+Mixcore Community License (MCL). See [LICENSE](LICENSE) for details.

packages/api/README.md

@@ -1,3 +1,83 @@
 # @mixcore/api
 
-API clients and endpoint wrappers for Mixcore SDK.
+API clients and endpoint wrappers for Mixcore SDK. Provides typed HTTP clients for interacting with Mixcore APIs.
+
+## Features
+
+- Typed API client with configurable base URL
+- Automatic request/response serialization
+- Built-in error handling
+- Support for authentication headers
+- Promise-based async operations
+
+## Installation
+
+```bash
+npm install @mixcore/api
+# or
+pnpm add @mixcore/api
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { ApiService } from '@mixcore/api';
+
+const api = new ApiService({
+  apiBaseUrl: 'https://api.mixcore.net',
+  apiKey: 'your-api-key' // optional
+});
+
+// Make API requests
+const response = await api.get('/some-endpoint');
+```
+
+### Configuration Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| apiBaseUrl | string | Base URL for API requests |
+| apiKey? | string | API key for authentication |
+| timeout? | number | Request timeout in ms |
+
+### Authentication
+
+```typescript
+// With API key
+const api = new ApiService({
+  apiBaseUrl: 'https://api.mixcore.net',
+  apiKey: 'your-api-key-here'
+});
+
+// Requests will include Authorization: Bearer header
+```
+
+## Error Handling
+
+The API client throws structured errors for:
+
+- Network failures
+- Invalid responses (non-2xx status codes)
+- Timeouts
+
+```typescript
+try {
+  await api.get('/some-endpoint');
+} catch (error) {
+  console.error('API request failed:', error.message);
+  if (error.response) {
+    console.error('Status:', error.response.status);
+  }
+}
+```
+
+## Related Packages
+
+- [@mixcore/database](https://github.com/mixcore/javascript-sdk/tree/main/packages/database): Database services using this API client
+- [@mixcore/base](https://github.com/mixcore/javascript-sdk/tree/main/packages/base): Base service classes
+
+## License
+
+Mixcore Community License (MCL). See [LICENSE](../../LICENSE) for details.

packages/base/README.md

@@ -1,18 +1,81 @@
-
 # @mixcore/base
 
-Mixcore SDK base abstractions. Provides core TypeScript classes and interfaces for all SDK packages, including `BaseService` and `BaseRestService`.
+Mixcore SDK base abstractions. Provides core TypeScript classes and interfaces for all SDK packages.
+
+## Features
+
+- **BaseService**: Abstract service class with common functionality
+- **BaseRestService**: REST API client base class
+- **Injectable configuration**: Flexible service configuration
+- **Framework-agnostic**: No UI/SPA dependencies
+
+## Installation
+
+```bash
+npm install @mixcore/base
+# or
+pnpm add @mixcore/base
+```
 
 ## Usage
 
-```ts
+### Extending BaseService
+
+```typescript
+import { BaseService } from '@mixcore/base';
+
+class MyService extends BaseService {
+  constructor(config: MyConfig) {
+    super(config);
+  }
+
+  async getData() {
+    return this.execute(() => {
+      // Your implementation
+    });
+  }
+}
+```
+
+### Using BaseRestService
+
+```typescript
 import { BaseRestService } from '@mixcore/base';
+
+class MyRestService extends BaseRestService {
+  constructor(baseUrl: string) {
+    super({ apiBaseUrl: baseUrl });
+  }
+
+  async fetchItems() {
+    return this.get('/items');
+  }
+}
 ```
 
-## Features
-- Abstract base classes for REST and service logic
-- Injectable configuration
-- No SPA/UI dependencies
+## API Reference
+
+### BaseService
+
+| Method | Description |
+|--------|-------------|
+| `execute(fn)` | Wraps operations with error handling |
+| `getConfig()` | Returns current configuration |
+
+### BaseRestService
+
+| Method | Description |
+|--------|-------------|
+| `get(path)` | Makes GET request |
+| `post(path, data)` | Makes POST request |
+| `put(path, data)` | Makes PUT request |
+| `delete(path)` | Makes DELETE request |
+
+## Related Packages
+
+- [@mixcore/api](https://github.com/mixcore/javascript-sdk/tree/main/packages/api): API client implementation
+- [@mixcore/database](https://github.com/mixcore/javascript-sdk/tree/main/packages/database): Database services extending these base classes
 
 ## License
-SEE LICENSE IN LICENSE
+
+Mixcore Community License (MCL). See [LICENSE](../../LICENSE) for details.

packages/config/README.md

@@ -1,3 +1,79 @@
 # @mixcore/config
 
-Configuration domain services and types for Mixcore SDK.
+Configuration management services for Mixcore SDK. Provides loading, validation and access to application configuration.
+
+## Features
+
+- Load configuration from multiple sources (files, env vars, etc.)
+- Type-safe configuration access
+- Schema validation
+- Environment variable support
+- Hot-reloading for development
+
+## Installation
+
+```bash
+npm install @mixcore/config
+# or
+pnpm add @mixcore/config
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { ConfigurationServices } from '@mixcore/config';
+
+const configService = new ConfigurationServices();
+
+// Load config from default location
+const config = await configService.loadConfiguration();
+
+// Access config values
+console.log(config.apiBaseUrl);
+```
+
+### Custom Configuration Path
+
+```typescript
+const config = await configService.loadConfiguration('/path/to/config.json');
+```
+
+### Environment Variables
+
+Configuration values can be overridden by environment variables prefixed with `MIXCORE_`:
+
+```bash
+MIXCORE_API_BASE_URL=https://api.mixcore.net npm start
+```
+
+## Configuration Schema
+
+The expected configuration format:
+
+```typescript
+interface AppConfig {
+  apiBaseUrl: string;
+  apiKey?: string;
+  debug?: boolean;
+  // ...other app-specific settings
+}
+```
+
+## API Reference
+
+| Method | Description |
+|--------|-------------|
+| `loadConfiguration(path?)` | Loads and validates config |
+| `getConfig()` | Returns current config |
+| `watchForChanges()` | Enables hot-reloading |
+
+## Related Packages
+
+- [@mixcore/api](https://github.com/mixcore/javascript-sdk/tree/main/packages/api): API client using this config
+- [@mixcore/base](https://github.com/mixcore/javascript-sdk/tree/main/packages/base): Base service classes
+
+## License
+
+Mixcore Community License (MCL). See [LICENSE](../../LICENSE) for details.

packages/database/README.md

@@ -1,3 +1,52 @@
 # @mixcore/database
 
-Database domain services and types for Mixcore SDK.
+Database domain services and types for Mixcore SDK. Provides data access, querying, and persistence services.
+
+## Features
+
+- REST API clients for Mixcore database operations
+- TypeScript interfaces for database models
+- Data validation and transformation
+- Modular service architecture
+
+## Installation
+
+```bash
+npm install @mixcore/database
+# or
+pnpm add @mixcore/database
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { ModuleDataService } from '@mixcore/database';
+import { ApiService } from '@mixcore/api';
+
+const api = new ApiService({ apiBaseUrl: 'https://api.mixcore.net' });
+const dataService = new ModuleDataService({ api });
+
+// Fetch data items
+const result = await dataService.fetchDataItems('module-id');
+```
+
+### Services
+
+- `ModuleDataService`: Core data operations
+- `MixDatabaseDataRestPortalService`: Portal-specific data services
+- `RelatedAttributeDataRestPortalService`: Related attribute services
+
+## API Reference
+
+See [API Documentation](API.md) for detailed method signatures and types.
+
+## Related Packages
+
+- [@mixcore/api](https://github.com/mixcore/javascript-sdk/tree/main/packages/api): API client foundation
+- [@mixcore/base](https://github.com/mixcore/javascript-sdk/tree/main/packages/base): Base service classes
+
+## License
+
+Mixcore Community License (MCL). See [LICENSE](../../LICENSE) for details.