diff --git a/README.md b/README.md index 3d0010f..4a078db 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ # Ignite UI Help samples + +## Running the samples locally + +1. Install all dependencies: + + ``` + npm install + ``` + +2. Build the samples specifying what version to build and the source folder for it as arguments: + + + ``` + npm run build -- --version 17.1 --ignite-ui http://localhost/ig_ui17.1 + ``` + +3. The built samples will be located under the ./dist folder. \ No newline at end of file diff --git a/package.json b/package.json index c9ca9e9..27bf8a2 100644 --- a/package.json +++ b/package.json @@ -1,17 +1,16 @@ { "name": "help-samples-src", "version": "0.0.1", - "description": "", - "devDependencies": { - "cheerio": "^0.22.0", - "gulp": "^3.9.1", - "gulp-util": "^3.0.8", - "through2": "^2.0.3" - }, + "description": "help samples", + "license": "MIT", + "homepage": "https://github.com/IgniteUI/help-samples-src#readme", "repository": { "type": "git", "url": "git+https://github.com/IgniteUI/help-samples-src.git" }, + "bugs": { + "url": "https://github.com/IgniteUI/help-samples-src/issues" + }, "keywords": [ "Ignite", "UI", @@ -19,9 +18,13 @@ "help", "docs" ], - "license": "MIT", - "bugs": { - "url": "https://github.com/IgniteUI/help-samples-src/issues" + "devDependencies": { + "cheerio": "^0.22.0", + "gulp": "^3.9.1", + "gulp-util": "^3.0.8", + "through2": "^2.0.3" }, - "homepage": "https://github.com/IgniteUI/help-samples-src#readme" + "scripts": { + "build": "gulp build-samples" + } }