chore: rename repository to MetonaSqlark
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# metona-sqlark
|
||||
# MetonaSqlark
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/version-0.1.12-blue?style=flat-square" alt="version">
|
||||
@@ -30,15 +30,15 @@
|
||||
## 📦 安装
|
||||
|
||||
```bash
|
||||
npm install @metona-team/metona-sqlark
|
||||
npm install @metona-team/MetonaSqlark
|
||||
```
|
||||
|
||||
```typescript
|
||||
// ESM / TypeScript
|
||||
import { MetonaSqlark, MeSqlark } from '@metona-team/metona-sqlark';
|
||||
import { MetonaSqlark, MeSqlark } from '@metona-team/MetonaSqlark';
|
||||
|
||||
// Browser UMD
|
||||
<script src="metona-sqlark.min.js"></script>
|
||||
<script src="MetonaSqlark.min.js"></script>
|
||||
// → window.MetonaSqlark / window.MeSqlark
|
||||
```
|
||||
|
||||
@@ -47,7 +47,7 @@ import { MetonaSqlark, MeSqlark } from '@metona-team/metona-sqlark';
|
||||
## 🚀 快速开始
|
||||
|
||||
```typescript
|
||||
import { MetonaSqlark } from '@metona-team/metona-sqlark';
|
||||
import { MetonaSqlark } from '@metona-team/MetonaSqlark';
|
||||
|
||||
// 创建数据库
|
||||
const db = await MetonaSqlark.create({
|
||||
@@ -94,7 +94,7 @@ await db.transaction(async (trx) => {
|
||||
|
||||
| 属性 | 类型 | 默认 | 说明 |
|
||||
|------|------|------|------|
|
||||
| `name` | `string` | `'metona-sqlark'` | 数据库名称 |
|
||||
| `name` | `string` | `'MetonaSqlark'` | 数据库名称 |
|
||||
| `mode` | `'memory' \| 'disk' \| 'hybrid'` | `'hybrid'` | 存储模式 |
|
||||
| `diskEngine` | `'indexeddb' \| 'opfs'` | `'indexeddb'` | 磁盘引擎 |
|
||||
| `version` | `number` | `1` | 版本号 |
|
||||
@@ -125,11 +125,11 @@ await db.transaction(async (trx) => {
|
||||
|
||||
```tsx
|
||||
// React
|
||||
import { useQuery } from '@metona-team/metona-sqlark/react';
|
||||
import { useQuery } from '@metona-team/MetonaSqlark/react';
|
||||
const { data, loading, refresh } = useQuery(db, 'SELECT * FROM users');
|
||||
|
||||
// Vue
|
||||
import { useSqlarkQuery } from '@metona-team/metona-sqlark/vue';
|
||||
import { useSqlarkQuery } from '@metona-team/MetonaSqlark/vue';
|
||||
const { data, loading, refresh } = useSqlarkQuery(db, 'SELECT * FROM users');
|
||||
```
|
||||
|
||||
@@ -181,4 +181,4 @@ src/
|
||||
|
||||
## 📄 License
|
||||
|
||||
MIT © [MetonaTeam](https://git.metona.cn/MetonaTeam)
|
||||
MIT © [MetonaTeam](https://git.metona.cn/MetonaTeam/MetonaSqlark)
|
||||
|
||||
Reference in New Issue
Block a user