Skip to content

Commit 1809099

Browse files
authored
docs: minor updates to README.md and add section on binaries (#362)
1 parent c0eda8a commit 1809099

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

Diff for: README.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,34 @@ npx geostyler-cli --output new-qgis-style.qml my-existing.sld
1111

1212
## Requirements
1313

14-
Requires [Node.js](https://nodejs.org/) and
15-
[npx](https://www.npmjs.com/package/npx) or [npm](https://www.npmjs.com/), both usually come with Node.js.
14+
`geostyler-cli` can either be run as a standalone application or installed using [Node.js](https://nodejs.org/).
15+
16+
## Standalone application
17+
18+
Binaries are available for Linux, MacOS, and Windows on the
19+
[Releases](https://github.com/geostyler/geostyler-cli/releases) page.
20+
Download the zip file for your operating system, unzip, navigate to the folder
21+
and run the `geostyler` command:
22+
23+
```
24+
geostyler --output new-qgis-style.qml my-existing.sld
25+
```
1626

1727
## Usage without installation ⚡
1828

29+
`Node.js` includes [npx](https://docs.npmjs.com/cli/v10/commands/npx), this
30+
allows you to run commands from an npm package without having to install it.
31+
1932
```
2033
npx geostyler-cli -s sld -t qgis -o output.qml input.sld
2134
```
2235

23-
2436
## Global installation
2537

2638
### Installation 💾
2739

28-
Once:
40+
`Node.js` includes [npm](https://docs.npmjs.com/cli/v10/commands/npm) - the
41+
JavaScript package manager. To install the `geostyler` command globally:
2942

3043
```
3144
npm install -g geostyler-cli
@@ -80,7 +93,7 @@ geostyler [options] -t qgis -o /path/to/output /path/to/input/
8093
the extension of the input file. Mandatory if the the target
8194
is a directory.
8295
* `-t` / `--target` Target parser, either `mapbox`, `sld` (for SLD 1.0), `se` (for SLD 1.1),
83-
`qgis` or `qml`. If not given, it will be guessed from
96+
and `qgis` or `qml` for QGIS QML files. If not given, it will be guessed from
8497
the extension of the output file. Mandatory if the the target
8598
is a directory.
8699
Mapfiles are currently not supported as target.

0 commit comments

Comments
 (0)