Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KaiVolland committed Sep 16, 2024
1 parent 061833d commit 707de35
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ bunx geostyler-cli --output new-qgis-style.qml my-existing.sld

## Requirements

`geostyler-cli` can either be run as a standalone application or installed using [Node.js](https://nodejs.org/).
`geostyler-cli` can either be run as a standalone application or installed using [bun.sh](https://bun.sh/).

## Standalone application

Expand All @@ -27,7 +27,7 @@ geostyler-cli --output new-qgis-style.qml my-existing.sld
## Usage without installation ⚡

`Bun` includes [bunx](https://bun.sh/docs/cli/bunx), this
allows you to run commands from an npm package without having to install it.
allows you to run a package without having to install it.

```
bunx geostyler-cli -s sld -t qgis -o output.qml input.sld
Expand Down Expand Up @@ -84,9 +84,9 @@ Mandatory if the the target is a directory.
In your clone of the repo, in the root directory:

```bash
bun install # get dependencies
bun run build # build from possibly changed source
# now you can call your build like this:
# install dependencies
bun install
# run the CLI
bun run start -- -s sld -t qgis -o output.qml testdata/point_simplepoint.sld
```

Expand Down
1 change: 0 additions & 1 deletion src/version.ts

This file was deleted.

0 comments on commit 707de35

Please sign in to comment.