From 032a52a1db91254c6dd165c3c4bf17599f6b3147 Mon Sep 17 00:00:00 2001 From: Martin Paucot Date: Sat, 9 Nov 2024 19:19:14 +0100 Subject: [PATCH] Update README.md --- README.md | 41 +---------------------------------------- 1 file changed, 1 insertion(+), 40 deletions(-) diff --git a/README.md b/README.md index b06de45..aaeeb85 100644 --- a/README.md +++ b/README.md @@ -3,48 +3,9 @@ ## @foadonis/magnify -### Plug and play full-text search for your Adonis application +#### Moved to [FriendsOfAdonis](https://github.com/FriendsOfAdonis/FriendsOfAdonis) repository
- -[![PRs Welcome](https://img.shields.io/badge/PRs-Are%20welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![License](https://img.shields.io/github/license/FriendsOfAdonis/magnify?label=License&style=flat-square)](LICENCE) [![@foadonis/magnify](https://img.shields.io/npm/v/%40foadonis%2Fmagnify?style=flat-square)](https://www.npmjs.com/package/@foadonis/magnify) - -
- -## Description - -Magnify provides a simple, driver based solution for adding full-text search to your Lucid models. Using Lucid hooks, Magnify automatically keep your search indexes in sync with your database. - -Currently, Magnify ships with [Algolia](https://algolia.com), [Meilisearch](https://www.meilisearch.com/) and [Typesense](https://typesense.org/) engines. Furthermore, writing custom engines is simple and you are free to extend Magnify with your own search implementations. - -```ts -// title: app/models/post.ts -import { compose } from '@adonisjs/core/helpers' -import { BaseModel, column } from '@adonisjs/lucid/orm' -import { Searchable } from '@foadonis/magnify' - -export default class Post extends compose(BaseModel, Searchable) { - @column({ isPrimary: true }) - declare id: string - - @column() - declare title: string -} -``` - -```ts -import Post from '#models/post' - -const posts = await Post.search('Adonis').take(10).get() -``` - -## Quickstart - -[Installation & Getting Started](https://friendsofadonis.github.io/docs/magnify/getting-started) - -## License - -[MIT licensed](LICENSE.md).