Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wirekang authored Dec 20, 2023
1 parent ee44869 commit 3349a75
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Checkout [official @adminjs/sql](https://github.com/SoftwareBrothers/adminjs-sql) for Postgres.
# This repository will be archived when the official adapter supports Mysql and Mariadb.

---

# [adminjs-sql](https://github.com/wirekang/adminjs-sql) [![NPM version](https://img.shields.io/npm/v/adminjs-sql?style=flat-square)](https://npmjs.org/package/adminjs-sql)

This is an inofficial [AdminJS](https://github.com/SoftwareBrothers/adminjs) adapter which integrates SQL-based database into AdminJS.
This is an unofficial [AdminJS](https://github.com/SoftwareBrothers/adminjs) adapter which integrates SQL-based database into AdminJS.

Installation: `yarn add adminjs-sql`

### Checkout [official @adminjs/sql](https://github.com/SoftwareBrothers/adminjs-sql) for postgres.
This repository will be archived when they support mysql.

## Usage

Expand Down Expand Up @@ -108,13 +111,3 @@ We use docker compose to run various databases for testing.

- MySQL
- MariaDB

## Todo

- [ ] Support Postgres.

- [ ] Elaborate unit testing.

- [ ] Add more complex example app.

Contributions are welcome!!

0 comments on commit 3349a75

Please sign in to comment.