chore: updated readme
This commit is contained in:
parent
4754f4a0c0
commit
b8dffc41e6
1 changed files with 8 additions and 29 deletions
37
README.md
37
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
|
||||
#### Running
|
||||
|
||||
Run the server.
|
||||
|
||||
```bash
|
||||
bun dev
|
||||
```
|
||||
|
||||
### Server
|
||||
|
||||
#### Run a development 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.
|
||||
|
|
Loading…
Reference in a new issue