From fdf622eeae91a1d7c5cb78bc3ee02cec5ccb054b Mon Sep 17 00:00:00 2001 From: Eric Garrison Date: Mon, 17 May 2021 17:30:17 -0500 Subject: [PATCH] Update README.md Updated the documentation to make the outputPath property requirements more clear. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c83b39f..1bd43f5 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ You can also use the service to display the version and build hash in your appli ## Build Requirements -In order for the version check service to function, a post build script needs to be run after compiling your angular application so that the correct values are available to the service. The library's assets folder contains a file named `version.json` which is what will get read by the service. In your main `package.json` file, you will need a script, prefixed with `post`, to trigger the post build script, followed by an optional parameter, which is just the name of your project: +In order for the version check service to function, a post build script needs to be run after compiling your angular application so that the correct values are available to the service. The library's assets folder contains a file named `version.json` which is what will get read by the service. In your main `package.json` file, you will need a script, prefixed with `post`, to trigger the post build script, followed by an optional parameter, consumer, which is the outputPath directory set in your angular.json file behind `dist`: ``` { @@ -93,7 +93,7 @@ In order for the version check service to function, a post build script needs to ``` Notes: -- The project name is now optional as of version 1.0.5. If your `outputPath` is set to `dist`, leaving out the project name parameter will use the base `dist` output folder. +- The __*outputPath directory parameter*__ is now optional as of version 1.0.5. If your `outputPath` property is set to `dist`, leaving out the project name parameter will now use the base `dist` output folder. - The name of your post build script should be whatever you're using to trigger the build (ie. If your build script was named `buildmyproject`, your post build script would be `postbuildmyproject`). ## Current Limitations