From b472b7172a2b31d8a054fd523bc79585e6db3b39 Mon Sep 17 00:00:00 2001
From: Blaster4385 <blaster4385@tablaster.dev>
Date: Mon, 19 Feb 2024 22:47:26 +0530
Subject: chore: added readme

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5f99f4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,64 @@
+# Minibin
+
+This is a simple code sharing service and a URL shortener inspired by [katbin](https://katb.in).
+
+## Features
+
+- **Simplified Sharing:** Enable users to easily share code snippets by pasting them into a text box, generating a shortened URL, and sharing it with others.
+- **URL Shortening:** Implement a URL shortening feature to condense lengthy URLs generated for shared code snippets, making them more manageable and easier to share across various platforms.
+- **Syntax Highlighting:** Enhance code readability by incorporating syntax highlighting for different programming languages, ensuring that shared code snippets are presented clearly and accurately to viewers.
+
+## Tech Stack
+
+- [Bun](https://bun.sh/)
+- [Vite](https://vitejs.dev/)
+- [React](https://reactjs.org/)
+- [Prismjs](https://prismjs.com/)
+- [Go](https://go.dev/)
+- [SQLite](https://www.sqlite.org/)
+
+## Setup
+
+### Client
+
+#### Install dependencies
+
+```bash
+bun install
+```
+
+#### Run a development server
+
+```bash
+bun dev
+```
+
+### Server
+
+#### Run a development server
+
+```bash
+go run .
+```
+
+##### Optional flags
+
+- `--port` - The port to run the server on. Default is 8080.
+- `--db` - The path to the database file. Default is `./minibin.db`.
+
+#### Run a production server
+
+Build a binary.
+
+```bash
+go build
+```
+Run the server.
+
+```bash
+./minibin
+```
+
+## License
+
+This project is licensed under the GNU General Public License v3. See the LICENSE file for details.
-- 
cgit v1.2.3-73-gaa49b