Skip to content

Commit cfff305

Browse files
author
fabianmoronzirfas
committed
docs(global vs local): note that global install is not working
1 parent f778e76 commit cfff305

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,18 @@ Extendscriptr relays on [`extendscript.prototypes`](https://github.com/fabianthe
1212
Extendscriptr doesn't use an existing full-stack polyfills like `babel-polyfill`, `es5-shim` or `shim.js` as they are intended for the browser and don't work well in adobe applications.
1313

1414
## Prerequisites
15-
This tool currently needs npm version 3.x or higher due to the flattend folder strcture.
15+
This tool currently needs npm version 3.x or higher due to the flattened folder structure.
1616

1717
## Usage
18-
We recommend using it as a local dependency
18+
We recommend using it as a local dependency\*
1919

2020
- `npm install extendscriptr --save-dev`
2121
- `./node_modules/.bin/extendscriptr --script src/scripts/helloWorld.js --output dist/helloWord.js`
22-
- open the outputed file with ExtendScript Toolkit OR place your script in the relevant application script folder
22+
- open the outputted file with ExtendScript Toolkit OR place your script in the relevant application script folder
2323
- run it
2424

25+
\* a _global install is currently not working due to the fact that ExtendScript is missing to many functions. See [this issue](https://github.com/ExtendScript/extendscriptr/issues/22)_
26+
2527
## Authors/Contributors
2628
- Lucas Vogel [@vogelino](https://github.com/vogelino)
2729
- Fabian Morón Zirfas [@fabiantheblind](https://github.com/fabiantheblind)
@@ -30,7 +32,7 @@ We recommend using it as a local dependency
3032
We would be happy to have contributions from other members as well. Don't hesitate to make pull requests or contact us if you wish to get contributor rights.
3133

3234
#### Publish with semantic release and conventional commits
33-
Publishing new versions of extendscriptr is handled by [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release). This means that new versions will be built on travis and published on every push based on the latest commit message. Therefor, commit messages need to satisfy [some conventions](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md). The project uses [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) to facilitate the messages formatting. Make sur to commit by running ``npm run commit`` instead of ``git commit [-m"change" ...]`` to be prompted to the conventional changelog form.
35+
Publishing new versions of extendscriptr is handled by [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release). This means that new versions will be built on travis and published on every push based on the latest commit message. Therefor, commit messages need to satisfy [some conventions](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md). The project uses [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) to facilitate the messages formatting. Make sure to commit by running ``npm run commit`` instead of ``git commit [-m"change" ...]`` to be prompted to the conventional changelog form.
3436

3537
### Report issues
3638
Feel free to report any issue you would encounter using the module.

0 commit comments

Comments
 (0)