From a9d826a7dbe7df4501fbf82a47d2c3a77ca9e0c0 Mon Sep 17 00:00:00 2001
From: Ray Foss <ray@vblip.com>
Date: Mon, 10 Apr 2023 18:33:28 -0500
Subject: [PATCH] fix(memory): Fix memory adapter readme (#3153)

---
 packages/memory/README.md | 83 +--------------------------------------
 1 file changed, 2 insertions(+), 81 deletions(-)

diff --git a/packages/memory/README.md b/packages/memory/README.md
index a854926019..635c9d36d9 100644
--- a/packages/memory/README.md
+++ b/packages/memory/README.md
@@ -12,88 +12,9 @@ $ npm install --save @feathersjs/memory
 
 > **Important:** `@feathersjs/memory` implements the [Feathers Common database adapter API](https://docs.feathersjs.com/api/databases/common.html) and [querying syntax](https://docs.feathersjs.com/api/databases/querying.html).
 
-## API
+## Documentation
 
-### `service([options])`
-
-Returns a new service instance initialized with the given options.
-
-```js
-const service = require('@feathersjs/memory')
-
-app.use('/messages', service())
-app.use('/messages', service({ id, startId, store, events, paginate }))
-```
-
-**Options:**
-
-- `id` (_optional_, default: `'id'`) - The name of the id field property.
-- `startId` (_optional_, default: `0`) - An id number to start with that will be incremented for every new record (unless it is already set).
-- `store` (_optional_) - An object with id to item assignments to pre-initialize the data store
-- `events` (_optional_) - A list of [custom service events](https://docs.feathersjs.com/api/events.html#custom-events) sent by this service
-- `paginate` (_optional_) - A [pagination object](https://docs.feathersjs.com/api/databases/common.html#pagination) containing a `default` and `max` page size
-- `whitelist` (_DEPRECATED_) - renamed to `allow`
-- `allow` (_optional_) - A list of additional query parameters to allow
-- `multi` (_optional_) - Allow `create` with arrays and `update` and `remove` with `id` `null` to change multiple items. Can be `true` for all methods or an array of allowed methods (e.g. `[ 'remove', 'create' ]`)
-
-## Example
-
-Here is an example of a Feathers server with a `messages` in-memory service that supports pagination:
-
-```
-$ npm install @feathersjs/feathers @feathersjs/express @feathersjs/socketio @feathersjs/errors @feathersjs/memory
-```
-
-In `app.js`:
-
-```js
-const feathers = require('@feathersjs/feathers')
-const express = require('@feathersjs/express')
-const socketio = require('@feathersjs/socketio')
-
-const memory = require('@feathersjs/memory')
-
-// Create an Express compatible Feathers application instance.
-const app = express(feathers())
-// Turn on JSON parser for REST services
-app.use(express.json())
-// Turn on URL-encoded parser for REST services
-app.use(express.urlencoded({ extended: true }))
-// Enable REST services
-app.configure(express.rest())
-// Enable REST services
-app.configure(socketio())
-// Create an in-memory Feathers service with a default page size of 2 items
-// and a maximum size of 4
-app.use(
-  '/messages',
-  memory({
-    paginate: {
-      default: 2,
-      max: 4
-    }
-  })
-)
-// Set up default error handler
-app.use(express.errorHandler())
-
-// Create a dummy Message
-app
-  .service('messages')
-  .create({
-    text: 'Message created on server'
-  })
-  .then((message) => console.log('Created message', message))
-
-// Start the server.
-const port = 3030
-
-app.listen(port, () => {
-  console.log(`Feathers server listening on port ${port}`)
-})
-```
-
-Run the example with `node app` and go to [localhost:3030/messages](http://localhost:3030/messages).
+See [FeathersJS Docs - Memory Adapter](https://feathersjs.com/api/databases/memory.html).
 
 ## License