Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated the documentation to make the outputPath property requirements more clear.
  • Loading branch information
IceBreakerG authored May 17, 2021
1 parent bedfe17 commit fdf622e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

```
{
Expand All @@ -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
Expand Down

0 comments on commit fdf622e

Please sign in to comment.