Skip to content

Commit 25b8d3b

Browse files
committed
✨ docs(README): add shields and improve installation instructions
- added shields for license, last commit, npm downloads, and npm version - improved installation instructions to include npx, bunx, and pnpm dlx - removed separate installation section - updated supported databases to include Vercel Postgres
1 parent 5568fde commit 25b8d3b

File tree

1 file changed

+9
-18
lines changed

1 file changed

+9
-18
lines changed

README.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
A powerful CLI tool to automatically scaffold and configure database setup using **Drizzle ORM** for PostgreSQL,SQLite,MySQL and More.
44

5-
---
5+
![GitHub License](https://img.shields.io/github/license/devgauravjatt/drizzle-setup?logo=github)
6+
![GitHub last commit](https://img.shields.io/github/last-commit/devgauravjatt/drizzle-setup?logo=git)
7+
![NPM Downloads](https://img.shields.io/npm/dw/drizzle-setup?logo=npm&color=%23f75352)
8+
![NPM Version](https://img.shields.io/npm/v/drizzle-setup?logo=npm&color=%23f75352)
69

710
## ✨ Features
811

@@ -14,24 +17,14 @@ A powerful CLI tool to automatically scaffold and configure database setup using
1417

1518
---
1619

17-
## 📦 Installation
18-
19-
Install globally via your preferred package manager:
20-
21-
```bash
22-
npm install -g drizzle-setup
23-
# or
24-
npx drizzle-setup
25-
```
26-
27-
---
28-
2920
## 🚀 Quick Start
3021

3122
Just run the CLI in your project directory:
3223

3324
```bash
34-
drizzle-setup
25+
npx drizzle-setup #or
26+
bunx drizzle-setup #or
27+
pnpm dlx drizzle-setup #or
3528
```
3629

3730
You'll be guided through:
@@ -48,7 +41,7 @@ You'll be guided through:
4841

4942
## 🧪 Supported Databases
5043

51-
- PostgreSQL - Default, Neon
44+
- PostgreSQL - Default, Neon, Vercel Postgres
5245
- SQLite - Default, Turso, Bun SQLite
5346

5447
Each database type comes with its own pre-configured templates and `.env` variables.
@@ -72,6 +65,4 @@ project-root/
7265

7366
## 📄 License
7467

75-
MIT License
76-
77-
---
68+
## MIT License

0 commit comments

Comments
 (0)