react-rock 3.1.4 → 3.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-rock",
-  "version": "3.1.4",
+  "version": "3.1.6",
   "author": "Naxrul Ahmed",
   "description": "React-Rock is a modern, lightweight state management library designed to simplify handling global state in React applications. With a minimal API and powerful features like freezing data updates for optimized re-renders, React-Rock allows you to manage state more efficiently while ensuring your app remains fast and responsive.",
   "main": "./index.js",

package/readme.md

@@ -1,4 +1,8 @@
-# React-Rock Documentation
+<p align="center">
+  <img width="120" src="https://raw.githubusercontent.com/devnax/react-rock/main/logo.png" alt="React Rock logo">
+</p>
+
+<h1 align="center">React Rock</h1>
 
 React-Rock is a lightweight package for managing global state in React applications. It simplifies handling data by providing a store with rows and metadata, while offering methods to perform CRUD operations and more. It enables easy integration with React components, making it an ideal solution for managing complex state in large applications.
 
@@ -79,7 +83,7 @@ Here’s a table with all available methods and their descriptions:
 The `find` method allows you to search for rows in the store based on specific conditions:
 
 ```typescript
-const foundUsers = users.find({ name: { equalWith: 'John Doe' } });
+const foundUsers = users.find({ name: 'John Doe' } });
 console.log(foundUsers);
 ```
 
@@ -153,10 +157,10 @@ class UserList extends StoreComponent {
 users.create({ name: 'Alice', age: 25 });
 
 // Update a user
-users.update({ age: 26 }, { name: { equalWith: 'Alice' } });
+users.update({ age: 26 }, { name: 'Alice' } });
 
 // Delete a user
-users.delete({ name: { equalWith: 'Alice' } });
+users.delete({ name: 'Alice' } });
 ```
 
 ## Examples with `find` and Query
@@ -167,7 +171,7 @@ const usersOver25 = users.find({ age: { gt: 25 } });
 console.log(usersOver25);
 
 // Find the first user with the name 'Alice'
-const alice = users.findFirst({ name: { equalWith: 'Alice' } });
+const alice = users.findFirst({ name: 'Alice' } });
 console.log(alice);
 ```
 
@@ -180,7 +184,7 @@ import { StoreComponent } from 'react-rock';
 
 class UserList extends StoreComponent {
     render() {
-        const users = this.store.getAll();
+        const users = users.getAll();
         return (
             <div>
                 {users.map(user => <div key={user._id}>{user.name}</div>)}
@@ -191,7 +195,7 @@ class UserList extends StoreComponent {
 
 class UserProfile extends StoreComponent {
     render() {
-        const user = this.store.findFirst({ name: { equalWith: 'John Doe' } });
+        const user = users.findFirst({ name: 'John Doe' });
         return <div>{user ? user.name : 'User not found'}</div>;
     }
 }