diff --git a/README.md b/README.md index d72b73b..6ac2003 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,40 @@ -# CSInterface (with Promise support) + +# Implementation of Adobe extensions CSInterface library, in Typescript and with Promise support + Full TypeScript CSInterface (v8, v9, v10 & v11) -# IMSInterface +The implementation is (hopefully) identical to the original one from CSInterface written in JavaScript. + +Related pages, and additional resource where you can find more information about Adobe HTML extensions. + +## Adobe CEP Resources +The original source can be found at [GitHub](https://github.com/Adobe-CEP/CEP-Resources/) in the respective subdirectory `CEP_X.x/` + +## Usage + +### With NPM + +Just install [NPM package](https://www.npmjs.com/package/@extendscript/csinterface) using `npm` CLI: +```bash +npm i @extendscript/csinterface --save +``` + +### Build from source +Clone the repository with the following command: +```bash +git clone https://github.com/ExtendScript/CSInterface.git +``` + +Install the dependencies: +```bash +npm i --save-dev +``` + +Build the library: +```bash +npm run build +``` + + +## IMSInterface https://github.com/unhurdle/cep-royale/blob/master/CEP6.1/src/com/adobe/cep/CEPGlobal.as