diff --git a/resources/gosh/README.md b/resources/gosh/README.md index 1337a8a65b..b2f3cf4f5d 100644 --- a/resources/gosh/README.md +++ b/resources/gosh/README.md @@ -1,33 +1,24 @@ # `@keymanapp/resources-gosh` -gosh is a simple platform-agnostic launcher for bash scripts. On Windows, it will locate an installation of Git for Windows and use bash from that script. On *nix, it uses the system-supplied version of bash. +`gosh` is a simple platform-agnostic launcher for bash scripts. On Windows, it will locate an installation of Git for Windows and use bash from that script. On \*nix, it uses the system-supplied version of bash. -TODO: it would be possible for gosh to grab a newer version of bash on macOS which could simplify some of our cross-platform scripts? +> **TODO**: it would be possible for gosh to grab a newer version of bash on macOS which could simplify some of our cross-platform scripts? ## Usage -gosh can be run as an npm module command or from the command line with the `gosh`/`gosh.bat` pair. The first parameter should be the bash script to run, and all subsequent parameters passed to gosh will be passed to the script unmodified. Note that paths passed to gosh should always use forward slashes (`/`), irrespective of the platform. +`gosh` can be run as an npm module command or from the command line with the `gosh`/`gosh.bat` pair. The first parameter should be the bash script to run, and all subsequent parameters passed to gosh will be passed to the script unmodified. Note that paths passed to gosh should always use forward slashes (`/`), irrespective of the platform. ## Examples -* `package.json`: +### `package.json` -\``` - ... - "scripts": { - "tsc": "tsc", +Invoke bash scripts using `gosh` instead: + +```json + "scripts": { + "build": "gosh ./build.sh", "test": "gosh ./unit_tests/test.sh" - }, - ... -\``` + }, +``` * `TeamCity instantiation`: (path = `web/source`) `../../resources/gosh/gosh ./build.sh -publish-sentry` - - -## Usage - -``` -const resourcesGosh = require('@keymanapp/resources-gosh'); - -// TODO: DEMONSTRATE API -```