Add documentation & example for ORM support

javascript/README.md

@@ -23,6 +23,8 @@ pnpm add retoolrpc
 
 ```javascript
 import { RetoolRPC } from 'retoolrpc'
+// for CommonJS, uses `require`, e.g.:
+// var { RetoolRPC} = require('retoolrpc')
 
 const rpc = new RetoolRPC({
   apiToken: 'your-api-token-here', // Replace this token with your API token
@@ -49,3 +51,24 @@ rpc.register({
 
 await rpc.listen()
 ```
+
+## ORM Support
+
+For users of [Sequelize](https://sequelize.org/), we offer an ORM mixin that enables the addition of fundamental model functions with a single function call, `registerModel`. When you register a model with `rpc`, it automatically registers various remote functions for the model, including `create`, `update`, `createOrUpdate`, `findByPk`, `findBy`, and `findAll`. You can find additional details [here](https://github.com/tryretool/retoolrpc/blob/main/javascript/src/addons/sequelize.ts#L5-L14).
+
+Following is an example of registering a `User` model:
+```javascript
+import { RetoolRPC, sequelizeMixin } from 'retoolrpc'
+import { User } from './orm/models' // the path to your model may be different
+
+const CustomRPC = sequelizeMixin(RetoolRPC)
+const rpc = new CustomRPC({ ... })
+
+rpc.registerModel({
+  model: Experiment,
+  findByAttributes: ['id', 'name'],
+  writeAttributes: ['name'],
+})
+```
+
+We plan to support other ORMs in the future.