Skip to content

Commit c25c497

Browse files
authored
Update README.md
1 parent 34b5c09 commit c25c497

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# ❄️ Snow Leopard - AI-Powered Writing Assistant
1+
# Snow Leopard - AI-Powered Writing Assistant
22

3-
## 🎯 What is Snow Leopard?
3+
## What is Snow Leopard?
44
Snow Leopard is an intelligent writing environment designed to enhance your writing process with AI capabilities. It provides a seamless interface for document creation, editing, and collaboration, augmented by AI suggestions, content generation, and contextual chat.
55

6-
## Why Snow Leopard?
6+
## Why Snow Leopard?
77
Modern writing tools often lack deep AI integration or are closed-source. Snow Leopard aims to provide:
88

99
**Open-Source & Extensible** – Transparent development and easy integration.
@@ -16,7 +16,7 @@ Modern writing tools often lack deep AI integration or are closed-source. Snow L
1616

1717
---
1818

19-
## 🛠️ Tech Stack
19+
## Tech Stack
2020
* **Framework:** Next.js (App Router)
2121
* **Language:** TypeScript
2222
* **UI:** React, TailwindCSS, Shadcn UI
@@ -27,7 +27,7 @@ Modern writing tools often lack deep AI integration or are closed-source. Snow L
2727

2828
---
2929

30-
## 🚀 Getting Started
30+
## Getting Started
3131

3232
### Prerequisites
3333
Make sure you have the following installed:
@@ -135,7 +135,7 @@ GROQ_API_KEY="" # Get your key at https://console.groq.com/keys
135135

136136
---
137137

138-
### 🗄️ Database Management (Drizzle ORM)
138+
### Database Management (Drizzle ORM)
139139

140140
* **Location:** Schema (`packages/db/src/schema.ts`), Client (`src/index.ts`), and Migrations (`migrations/`) are in `packages/db`.
141141
* **Commands (Run from Root):**
@@ -148,15 +148,15 @@ GROQ_API_KEY="" # Get your key at https://console.groq.com/keys
148148

149149
---
150150

151-
### 🔐 Authentication (Better Auth)
151+
### Authentication (Better Auth)
152152

153153
* **Configuration:** Set `BETTER_AUTH_SECRET` and `BETTER_AUTH_URL` in `apps/snow-leopard/.env`.
154154
* **Adapter:** Uses the Drizzle adapter, configured in `apps/snow-leopard/lib/auth.ts` (imports `db` from `@snow-leopard/db`).
155155
* **Schema:** Requires `user`, `session`, `account`, `verification` tables (defined in `packages/db/src/schema.ts`). `pnpm db:push` applies these.
156156

157157
---
158158

159-
## 🤝 Contributing
159+
## Contributing
160160

161161
We welcome contributions! Please follow these steps:
162162

@@ -172,6 +172,6 @@ For bug reports and feature requests, please use GitHub Issues or the in-app fee
172172

173173
---
174174

175-
## 📜 License
175+
## License
176176

177177
This project is licensed under the **Apache License 2.0**. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)