Skip to content

Commit 0b0c956

Browse files
committed
improve installation instructions
1 parent 82fd57d commit 0b0c956

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,36 @@ to the user's browser.
103103

104104
## Get started
105105

106+
[Read the official *get started* guide on SQLPage's website](https://sql.ophir.dev/get_started.sql).
107+
108+
### Using native binaries
109+
110+
The easiest way to get started is to download the latest release from the
111+
[releases page](https://github.com/lovasoa/SQLpage/releases).
112+
113+
- Download the binary that corresponds to your operating system (linux, macos, or windows).
114+
- Uncompress it: `tar -xzf sqlpage-*.tgz`
115+
- Run it in a terminal: `./sqlpage.bin`
116+
117+
### With docker
118+
119+
To run on a server, you can use [the docker image](https://hub.docker.com/r/lovasoa/sqlpage):
120+
106121
- [Install docker](https://docs.docker.com/get-docker/)
107122
- In a terminal, run the following command:
108123
- `docker run -it --name sqlpage -p 8080:8080 --volume "$(pwd):/var/www" --rm lovasoa/sqlpage`
109124
- (`"$(pwd):/var/www"` allows sqlpage to run sql files from your current working directory)
110125
- Create a file called index.sql with the contents from [this example](./index.sql)
111126
- Open https://localhost:8080 in your browser
112127

128+
### On Mac OS, with homebrew
129+
130+
An alternative for Mac OS users is to use [SQLPage's homebrew package](https://formulae.brew.sh/formula/sqlpage).
131+
132+
- [Install homebrew](https://brew.sh/)
133+
- In a terminal, run the following commands:
134+
- `brew install sqlpage`
135+
113136

114137
## Examples
115138

0 commit comments

Comments
 (0)