diff --git a/packages/node/readme.md b/packages/node/readme.md index 6374b9d8..35938a5 100644 --- a/packages/node/readme.md +++ b/packages/node/readme.md @@ -6,6 +6,47 @@ Progress® Data Objects in an OpenEdge business application can be accessed usin The Data Source can be used by apps built as Node.js web apps. +### Usage + +This is an npm package. This means that node and npm need to be installed to use it. + +To use this package, you would normally just install it from the public NPM registry via an `npm install` command. You'll need to select a JSDO package depending on your environment: + +``` +# For vanilla JS, e.g. running it in a browser: +npm install @progress/jsdo-core + +# For usage with node: +npm install @progress/jsdo-node + +# For usage with Angular: +npm install @progress/jsdo-angular + +# For usage with Nativescript: +npm install @progress/jsdo-nativescript +``` + +If you want to add changes and build packages yourself from this repository, you will need to use the scripts in `package.json`. The package.json in this folder corresponds to the `@progress/jsdo-node` package. + +Here is a quick overview of the npm scripts: + +`npm install` + +> This installs the necessary dependencies that this package has and needs to be run at least once. + +`npm run build:ds` + +> This creates a `build` folder and produces in it a `progress.data.node.js` file that can be used either via including it in a `