From b8dffc41e6a31da2a30e91f98358228fabf8ca75 Mon Sep 17 00:00:00 2001 From: Blaster4385 Date: Tue, 20 Feb 2024 17:37:14 +0530 Subject: chore: updated readme --- README.md | 35 +++++++---------------------------- 1 file changed, 7 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index f5f99f4..a6f56e3 100644 --- a/README.md +++ b/README.md @@ -17,28 +17,20 @@ This is a simple code sharing service and a URL shortener inspired by [katbin](h - [Go](https://go.dev/) - [SQLite](https://www.sqlite.org/) -## Setup - -### Client - -#### Install dependencies +## Building +- Setup the required variables in the env file. +- Build the binary ```bash -bun install +make minibin ``` -#### Run a development server - -```bash -bun dev -``` +#### Running -### Server - -#### Run a development server +Run the server. ```bash -go run . +./minibin ``` ##### Optional flags @@ -46,19 +38,6 @@ go run . - `--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