@awes-io/vue-mc 0.9.2 → 0.10.0

package/README.md

@@ -1,39 +1,90 @@
-# Awes.io Models and Collections Abstract Layer
+# AwesCode UI Models and Collections Abstract Layer
 
 Based on [VueMC](https://vuemc.io/)
 
-## Basic usage
+## Installation
 
-1. Ensure you are using [@nuxtjs/axios](https://axios.nuxtjs.org/) in your project
-2. Install the module `yarn add @awes-io/vue-mc`
-3. Now you are ready to build models and collections
-4. Import your `BaseModel` and `BaseCollection` from this package
+```bash
+yarn add @awes-io/vue-mc
+```
+
+**Requirements:**
+- [@nuxtjs/axios](https://axios.nuxtjs.org/) must be installed in your project
+
+## Quick Start
 
 ```javascript
 import { BaseModel, BaseCollection } from '@awes-io/vue-mc'
 
+// Define a Model
 class Todo extends BaseModel {
     defaults() {
         return {
             id: null,
-            done: true
+            title: '',
+            done: false
+        }
+    }
+
+    routes() {
+        return {
+            fetch: '/api/todos/{id}',
+            save: '/api/todos',
+            delete: '/api/todos/{id}'
         }
     }
 }
 
+// Define a Collection
 class Todos extends BaseCollection {
     model() {
         return Todo
     }
+
+    routes() {
+        return {
+            fetch: '/api/todos'
+        }
+    }
 }
 
-export default Todos
+// Usage
+const todos = new Todos()
+await todos.fetch()
 ```
 
-## Build before release a new version
+## Documentation
+
+**Comprehensive documentation is available in the [/docs](./docs/) folder:**
+
+- **[Getting Started](./docs/index.md)** - Overview and quick start
+- **[Models Guide](./docs/models.md)** - Define and use models
+- **[Collections Guide](./docs/collections.md)** - Manage arrays of models
+- **[Request/Response](./docs/request-response.md)** - HTTP request handling
+- **[Validation](./docs/validation.md)** - Client and server validation
+- **[API Reference](./docs/api-reference.md)** - Complete API documentation
+
+## Key Features
+
+- **Models**: Represent individual entities with attributes, validation, and persistence
+- **Collections**: Manage arrays of models with pagination and filtering
+- **Axios Integration**: Built-in HTTP request/response handling via @nuxtjs/axios
+- **Validation**: Client-side and server-side validation support
+- **Reactive**: Fully reactive with Vue.js
+- **Lifecycle Hooks**: Boot, create, fetch, save, delete events
+
+## Development
+
+### Build before release
 
 ```bash
 $ yarn build
 ```
 
 Ensure to write proper commit message according to [Git Commit convention](https://www.conventionalcommits.org/)
+
+## External Resources
+
+- [VueMC Official Documentation](https://vuemc.io/)
+- [@nuxtjs/axios Documentation](https://axios.nuxtjs.org/)
+- [AwesCode UI Components](../ui/)