Skip to content

Commit 0575576

Browse files
committed
ci: add README
1 parent e071d5b commit 0575576

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# mboff
2+
3+
Mboff is tiny CLI that allows the optimisation of MBTiles by removing unnecessary data. You only need to provide it with a key/value pair and `mboff` will search and remove such data.
4+
5+
## Usage
6+
`mboff` requires the user to give a path to the existing *MBTiles* file and the key/value pair of the data you wish to remove from the file:
7+
```bash
8+
mboff [file path] [key value pair]
9+
```
10+
Example:
11+
```bash
12+
mboff myMap.mbtiles category=road
13+
```
14+
15+
## Future
16+
* Ability to provide zoom levels so data can be removed in specified zoom level. If no zoom level is specified, it applies to all zoom levels.
17+
* A command for *checking* if a key/value pair exist in a MBTiles file and how many times is present.
18+
19+
## License
20+
21+
See [`LICENSE`](./LICENSE)

cli.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ func off(ctx *cli.Context) error {
3030
if err := conn.update(results); err != nil {
3131
log.Fatal(err)
3232
}
33+
fmt.Println(fmt.Sprintf("Successful. The key/value %s was found in %d instance(s). MBTiles updated.", rawKeyValue, len(results)))
3334
} else {
3435
log.Fatal(fmt.Sprintf("The key value %s was not present in the MBTiles file. Nothing was removed.", keyValue))
3536
}

0 commit comments

Comments
 (0)