Skip to content

Commit 143a074

Browse files
authored
Add documentation about how to use an offline map (#49)
1 parent 512efcb commit 143a074

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,24 @@ For production environments like Azure, input the environmental variables via th
3939

4040
**Port:** Specify a port to serve the app. Default is 8080.
4141

42+
## How to use the outputs
43+
44+
Once the map request is completed, the user can download the offline map file, or scan a QR code to share a link to download the file.
45+
46+
The offline map file will be in either [MBTiles](https://wiki.openstreetmap.org/wiki/MBTiles) or [Styled Map Package](https://github.com/digidem/styled-map-package) format.
47+
48+
MBTiles can be used in a variety of applications to serve as a background map, including:
49+
50+
- [ODK Collect](https://getodk.org/)
51+
- [Kobo Collect](https://www.kobotoolbox.org/)
52+
- [Locus Map](https://www.locusmap.app/)
53+
54+
Styled Map Packages can be used in:
55+
56+
- [CoMapeo](https://comapeo.app/)
57+
58+
Please refer to the documentation for each application to learn how to import the offline map file.
59+
4260
## Build Setup
4361

4462
```bash

0 commit comments

Comments
 (0)