Skip to content

Commit 0a9533c

Browse files
authored
Merge pull request #397 from bertdeblock/update-readme
Update README file
2 parents c29005b + c119d20 commit 0a9533c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1-
ember-cli-app-version [![Build Status](https://travis-ci.org/ember-cli/ember-cli-app-version.svg?branch=master)](https://travis-ci.org/ember-cli/ember-cli-app-version) ![[EmberObserver Badge](http://emberobserver.com/addons/ember-cli-app-version)](http://emberobserver.com/badges/ember-cli-app-version.svg)
2-
==============================================================================
1+
# ember-cli-app-version
2+
3+
[![CI](https://github.com/ember-cli/ember-cli-app-version/workflows/CI/badge.svg)](https://github.com/ember-cli/ember-cli-app-version/actions?query=workflow%3ACI)
4+
[![NPM Version](https://badge.fury.io/js/ember-cli-app-version.svg)](https://badge.fury.io/js/ember-cli-app-version)
5+
[![Ember Observer Score](https://emberobserver.com/badges/ember-cli-app-version.svg)](https://emberobserver.com/addons/ember-cli-app-version)
36

47
Adds your Ember App's version to Info tab in Ember Inspector. The version is taken from your project's package.json#version.
58
If you add build metadata to the version, this addon will automatically append SHA to the end of the version.
69

710
## Compatibility
811

9-
* Ember.js v3.28 or above
10-
* Ember CLI v3.28 or above
11-
* Node.js v14 or above
12-
12+
- Ember.js v3.28 or above
13+
- Ember CLI v3.28 or above
14+
- Node.js v14 or above
1315

1416
## Installation
1517

1618
```
1719
ember install ember-cli-app-version
1820
```
1921

20-
2122
## Usage
2223

2324
![Ember Inspector Info Tab](https://www.evernote.com/shard/s51/sh/c2f52608-bc17-4d5c-ac76-dec044eeb2e2/2f08de0cfb77217502cfc3a9188d84bf/res/3fb1d3d9-d809-48f6-9d3b-6e9a4af29892/skitch.png?resizeSmall&width=832)
@@ -28,23 +29,23 @@ This addon provides `{{app-version}}` helper that allows you to show your curren
2829

2930
The addon has flags to display parts of the version:
3031

31-
* `{{app-version versionOnly=true}} // => 2.0.1`
32-
* `{{app-version versionOnly=true showExtended=true}} // => 2.0.1-alpha.1`
33-
* `{{app-version shaOnly=true}} // => <git SHA>`
32+
- `{{app-version versionOnly=true}} // => 2.0.1`
33+
- `{{app-version versionOnly=true showExtended=true}} // => 2.0.1-alpha.1`
34+
- `{{app-version shaOnly=true}} // => <git SHA>`
3435

3536
Flags are `false` by default.
3637

3738
## Heroku
3839

3940
When running on Heroku the `.git` folder is not present, making it impossible to fetch the `git SHA`. A workaround for this is adding the below in your `config/environment.js`:
4041

41-
```
42+
```js
4243
// Heroku Git Hash support
4344
if (process.env.SOURCE_VERSION) {
4445
const pkg = require('../package.json');
4546
const hash = process.env.SOURCE_VERSION.substr(0, 7);
4647
ENV['ember-cli-app-version'] = {
47-
version: `${pkg.version}+${hash}`
48+
version: `${pkg.version}+${hash}`,
4849
};
4950
}
5051
```
@@ -53,7 +54,6 @@ if (process.env.SOURCE_VERSION) {
5354

5455
See the [Contributing](CONTRIBUTING.md) guide for details.
5556

56-
5757
## License
5858

5959
This project is licensed under the [MIT License](LICENSE.md).

0 commit comments

Comments
 (0)