Skip to content

Commit

Permalink
docs: update example documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
saitho committed Mar 30, 2020
1 parent 5f6d793 commit 680d804
Show file tree
Hide file tree
Showing 4 changed files with 3,006 additions and 2,595 deletions.
25 changes: 21 additions & 4 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,29 @@
# SampleApp

This is an example Angular app showcasing the usage of ts-appversion.
Note that ts-appversion is in no way bound to Angular. Feel free to use it with any other TypeScript-based framework.

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.3.9.

## Development server
## Environments

Based on the environment different version formats are displayed.
The app will be launched at `http://localhost:4200/`.

### No environment

`npm run start` for a server with no environment.

* The displayed version should be the _latest Git tag_ from @saithodev/ts-appversion project (e.g. v1.3.0)

### Development

`npm run start:dev` for a server with development environment.

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
* The displayed version should be _1.0.0_ (from package.json) with the latest _hash_ of the@saithodev/ts-appversion project (e.g. 1.0.0-gda1e67f)</li>

## Build
### Production

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
`npm run start:prod` for a server with production environment.

* The displayed version should be _1.0.0_ (from package.json)
Loading

0 comments on commit 680d804

Please sign in to comment.