Skip to content

Commit 845e664

Browse files
committed
docs: update readme
1 parent c7b36a1 commit 845e664

1 file changed

Lines changed: 10 additions & 28 deletions

File tree

README.md

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# Drizzleasy
22

3-
[![npm version](https://badge.fury.io/js/drizzleasy.svg)](https://badge.fury.io/js/@remcostoeten/drizzleasy)
43
[![npm downloads](https://img.shields.io/npm/dm/@remcostoeten/drizzleasy.svg)](https://www.npmjs.com/package/@remcostoeten/drizzleasy)
54
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/@remcostoeten/drizzleasy)](https://bundlephobia.com/package/@remcostoeten/drizzleasy)
65
[![TypeScript](https://img.shields.io/badge/TypeScript-100%25-blue.svg)](https://www.typescriptlang.org/)
76
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8-
[![GitHub stars](https://img.shields.io/github/stars/remcostoeten/drizzleasy.svg?style=social)](https://github.com/remcostoeten/drizzleasy)
97

10-
Drizzleasy is a library to make CRUD operations and database management ridiculously easy. 100%
11-
typesafe with full LSP support in your editor due to the chainable syntax.
8+
<small><i>Because who doesn't love abstractions on top of abstractions</i></small>.<br/>
9+
As the name implies, makes CRUD ridiculously easy 100% type-safe, with an easy-to-understand chainable syntax and full LSP support.
1210

1311
### Quick Example
1412

@@ -28,29 +26,15 @@ const { data: premiumUsers } = await read('users').where({ isPremium: true })()
2826

2927
return { newUser, premiumUsers }
3028
```
31-
32-
## 📚 Documentation
29+
<hr/>
3330

3431
- **[Full Documentation](https://drizzleasy.vercel.app)** - Complete guides and API reference
35-
- **[Quickstart](https://drizzleasy.vercel.app/docs/quickstart)** - Get started in 5 minutes
36-
- **[API Reference](https://drizzleasy.vercel.app/docs/api/core)** - Detailed function documentation
37-
- **[FAQ](https://drizzleasy.vercel.app/docs/faq)** - Common questions and answers
32+
- **[Quickstart](https://drizzleasy.vercel.app/docs/03-quickstart)** - Get started in 5 minutes
33+
- **[API Reference](https://drizzleasy.vercel.app/docs/20-api/01-core)** - Common questions and answers
34+
- **[FAQ](https://drizzleasy.vercel.app/docs/60-faq)** - Detailed function documentation
3835

3936
![LSP Demo](premium-vscode-demo.gif)
4037

41-
## Features
42-
43-
- **One-liner setup** - `initializeConnection(url)` replaces complex Drizzle setup
44-
- **Auto-detection** - Reads your drizzle.config.ts automatically
45-
- **Multi-database** - PostgreSQL (Neon, Vercel, Docker), SQLite, Turso
46-
- **Simple syntax** - Natural operators like `age: '>18'` and `name: '*john*'`
47-
- **100% type-safe** - Full TypeScript support with IntelliSense
48-
- **Optimistic updates** - Built-in React hooks for smooth UX
49-
- **Environment switching** - Development/production database configs
50-
- **Connection caching** - Automatic connection reuse for performance
51-
- **Dual module support** - Works with both ESM and CommonJS
52-
- **Zero dependencies** - Only peer dependencies for database drivers
53-
5438
## Installation
5539

5640
```bash
@@ -63,7 +47,7 @@ bun add better-sqlite3 # SQLite
6347
bun add pg # Local PostgreSQL
6448
```
6549

66-
💡 **Not sure which driver?** See the [installation guide](https://drizzleasy.vercel.app/docs/installation)
50+
**Not sure which driver?** See the [installation guide]([https://drizzleasy.vercel.app/docs/installation](https://drizzleasy.vercel.app/docs/02-installation))
6751

6852
## Quick Start
6953

@@ -271,10 +255,8 @@ if (error) {
271255
console.log('Success:', data)
272256
```
273257

274-
## Contributing
275-
276-
Contributions are welcome! Please feel free to submit a Pull Request.
258+
MIT ©
277259

278-
## License
260+
xxx
261+
[Remco Stoeten](https://github.com/remcostoeten)
279262

280-
MIT © [Remco Stoeten](https://github.com/remcostoeten)

0 commit comments

Comments
 (0)