From 707de351d287ee4e80d3e371acf14eaf0e2932a1 Mon Sep 17 00:00:00 2001 From: Kai Volland Date: Mon, 16 Sep 2024 09:32:52 +0200 Subject: [PATCH] docs: update README.md --- README.md | 10 +++++----- src/version.ts | 1 - 2 files changed, 5 insertions(+), 6 deletions(-) delete mode 100644 src/version.ts diff --git a/README.md b/README.md index 11bf183..825b2d8 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 ``` diff --git a/src/version.ts b/src/version.ts deleted file mode 100644 index 8b90a51..0000000 --- a/src/version.ts +++ /dev/null @@ -1 +0,0 @@ -export default '4.0.0';