Update README.md

README.md

@@ -1,11 +1,11 @@
 # Surveilled
 
+A map of cameras in the world using OpenStreetMap overpass data.
+
 <img src="https://git.quad4.io/Quad4-Software/Surveilled/raw/commit/70503fcb56994c4c1bb019dfbcc3b589ebd94039/showcase/surveilled.png" alt="showcase image" width="900">
 
 Check out the live website at [surveilled.quad4.io](https://surveilled.quad4.io)
 
-A map of cameras in the world using OpenStreetMap overpass data.
-
 ## Disclaimer
 
 Data is fetched from OSM Overpass and may not be accurate or up to date as this data is community-sourced.
@@ -16,13 +16,29 @@ Data is fetched from OSM Overpass and may not be accurate or up to date as this
 - Measure distance between two points/cameras
 - Export or copy GeoJSON of cameras in an area
 - Customize Nominatim, Overpass, and Tile endpoints
-- No reliance on external CDNs or Google fonts.
+- No reliance on external CDNs or Google fonts
 - PWA installable
 - Mobile-friendly
 
-## Self-hosting
+## Quick Start
 
-### PNPM
+### Using Docker
+
+```sh
+docker run -p 3000:3000 git.quad4.io/quad4-software/surveilled:latest
+```
+
+Then open your browser at `http://localhost:3000`
+
+### Using Podman
+
+```sh
+podman run -p 3000:3000 git.quad4.io/quad4-software/surveilled:latest
+```
+
+Then open your browser at `http://localhost:3000`
+
+### Using PNPM
 
 ```sh
 pnpm config set @quad4:registry=https://git.quad4.io/api/packages/Quad4-Software/npm/
@@ -30,50 +46,53 @@ pnpm install -g @quad4/surveilled
 surveilled
 ```
 
-Or 
+Or with custom port and host:
 
 ```sh
 PORT=8080 HOST=0.0.0.0 surveilled
 ```
 
-### Docker
-
-```sh
-docker run -p 3000:3000 git.quad4.io/quad4-software/surveilled:latest
-```
-
-### Podman
-
-```sh
-podman run -p 3000:3000 git.quad4.io/quad4-software/surveilled:latest
-```
-
 ## Development
 
+### Prerequisites
+
+- Node.js `>=18.0.0`
+- pnpm `>=10.25.0`
+
+### Setup
+
 ```sh
 git clone https://git.quad4.io/Quad4-Software/Surveilled
 cd Surveilled
-```
-
-### PNPM
-
-```sh
 pnpm install
-pnpm run dev
 ```
 
-### Makefile
+### Task
+
+The project uses [Task](https://taskfile.dev/) for all development tasks.
 
-```sh
-make dev
 ```
+| Task          | Description                           |
+|---------------|---------------------------------------|
+| default       | Show available tasks                  |
+| dev           | Run development server                |
+| build         | Build the application                 |
+| package       | Package the application               |
+| publish       | Publish to npm registry               |
+| preview       | Preview production build              |
+| check         | Run type checking                     |
+| lint          | Run linter                            |
+| format        | Format code                           |
+| clean         | Clean build artifacts                 |
+| docker-build  | Build Docker image                    |
+| docker-run    | Run Docker container                  |
+| docker        | Build and run Docker container        |
+| setup         | Setup development environment         |
+| install       | Install dependencies                  |
+| install:ci    | Install dependencies for CI           |
 
-#### Check/Lint/Format
-
-```sh
-make check
-make lint
-make format
+example: task dev
+you might want to set alias alias task=`go-task`
 ```
 
 ## Building Docker Image
@@ -81,14 +100,20 @@ make format
 Uses Chainguard Images which are rootless and very minimal images.
 
 ```sh
-docker build -t surveilled .
-docker run --rm -p 3000:3000 surveilled
+task docker-build
+task docker-run
+```
+
+Or use the combined task:
+
+```sh
+task docker
 ```
 
 ## Contributing
 
 Send email to [team@quad4.io](mailto:team@quad4.io) with your feedback or any issues you may have.
 
-## LICENSE
+## License
 
 [BSD 3-Clause](LICENSE)