Skip to content

Commit a8d81ed

Browse files
authored
chore: add readme
1 parent 3b45b3d commit a8d81ed

1 file changed

Lines changed: 79 additions & 1 deletion

File tree

README.md

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,79 @@
1-
# Soon
1+
<div align="center">
2+
3+
<a href="https://sqlite3.online/" target="_blank">
4+
<img src="https://github.com/user-attachments/assets/aef749bf-df08-4a84-8148-d34b796449d8" alt="tgram" width="128">
5+
</a>
6+
7+
# SQLite Online
8+
9+
A fast, secure, and client-side SQLite editor that runs entirely in your browser—no server required. Powered by WebAssembly and built with sql.js and ReactJS, allows you to create, search, and edit SQLite databases effortlessly.
10+
11+
[![License](https://img.shields.io/github/license/vwh/sqlite-viewer?label=License)](https://github.com/vwh/sqlite-viewer/blob/main/LICENSE)
12+
[![Security Score](https://img.shields.io/badge/Security%20Score-A%20%7C%20Good-brightgreen)](https://snyk.io/test/github/vwh/sqlite-viewer)
13+
[![Codacy Badge](https://img.shields.io/codacy/grade/1a8379b2399b45278a710145f92eab5d)](https://app.codacy.com/gh/vwh/sqlite-viewer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
14+
[![CodeQL](https://github.com/vwh/sqlite-viewer/actions/workflows/codeql.yml/badge.svg)](https://github.com/vwh/sqlite-viewer/actions/workflows/codeql.yml)
15+
[![Format Check](https://github.com/vwh/sqlite-viewer/actions/workflows/format.yml/badge.svg)](https://github.com/vwh/sqlite-viewer/actions/workflows/format.yml)
16+
[![Lint](https://github.com/vwh/sqlite-viewer/actions/workflows/lint.yml/badge.svg)](https://github.com/vwh/sqlite-viewer/actions/workflows/lint.yml)
17+
18+
</div>
19+
20+
<div align="center">
21+
<a href="https://sqlite3.online/" target="_blank">
22+
<img src="https://github.com/user-attachments/assets/3d605950-0675-4748-bea8-69bd329731af" alt="SQLite Viewer Preview">
23+
</a>
24+
</div>
25+
26+
## Features
27+
28+
<table>
29+
<tr>
30+
<td align="center"><img src="https://raw.githubusercontent.com/lucide-icons/lucide/main/icons/globe.svg" width="40"><br><b>Browser Based</b></td>
31+
<td align="center"><img src="https://raw.githubusercontent.com/lucide-icons/lucide/main/icons/zap.svg" width="40"><br><b>Lightning Fast</b></td>
32+
<td align="center"><img src="https://raw.githubusercontent.com/lucide-icons/lucide/main/icons/shield.svg" width="40"><br><b>100% Secure</b></td>
33+
</tr>
34+
<tr>
35+
<td>
36+
• No installation required<br>
37+
• Access directly in browser<br>
38+
</td>
39+
<td>
40+
• WebAssembly-powered<br>
41+
• Handles large databases efficiently
42+
</td>
43+
<td>
44+
• Client-side processing<br>
45+
• Data never leaves your device<br>
46+
</td>
47+
</tr>
48+
<tr>
49+
<td align="center"><img src="https://raw.githubusercontent.com/lucide-icons/lucide/main/icons/settings.svg" width="40"><br><b>Customizable Interface</b></td>
50+
<td align="center"><img src="https://raw.githubusercontent.com/lucide-icons/lucide/main/icons/lock.svg" width="40"><br><b>Offline Capable</b></td>
51+
<td align="center"><img src="https://raw.githubusercontent.com/lucide-icons/lucide/main/icons/app-window.svg" width="40"><br><b>PWA Support</b></td>
52+
</tr>
53+
<tr>
54+
<td>
55+
• Adjustable settings<br>
56+
• Personalized user experience
57+
</td>
58+
<td>
59+
• Work without internet<br>
60+
• Ideal for sensitive data<br>
61+
</td>
62+
<td>
63+
• Install as desktop app<br>
64+
• Mobile device compatible<br>
65+
</td>
66+
</tr>
67+
</table>
68+
69+
> [!NOTE]
70+
> SQLite Viewer supports loading databases directly from a URL. Use the `url` parameter. <br>
71+
> Example: [`https://sqlite3.online/?url=...db_examples/chinook.db`](https://sqlite3.online/?url=https://github.com/vwh/sqlite-viewer/raw/main/db_examples/chinook.db)
72+
73+
## Contributing
74+
75+
Contributions are welcome! Feel free to open a pull request with your improvements or fixes.
76+
77+
## License
78+
79+
Under the MIT License. See [License](https://github.com/vwh/sqlite-viewer/blob/main/LICENSE) for more information.

0 commit comments

Comments
 (0)