@fmidev/smartmet-alert-client 4.0.0-rc.15 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/Jenkinsfile CHANGED
@@ -69,7 +69,7 @@ pipeline {
69
69
  }
70
70
 
71
71
  stage('Require unique deploy directory') {
72
- // when { environment name: 'BRANCH_NAME', value: 'main' }
72
+ when { environment name: 'BRANCH_NAME', value: 'main' }
73
73
  steps {
74
74
  sh "ssh ${deployUserAndHost} \"if [ -d ${deployBaseDirectory}/${packageVersion} ]; then echo deploy directory already exists; exit 1; fi\""
75
75
  }
@@ -84,7 +84,7 @@ pipeline {
84
84
  }
85
85
 
86
86
  stage('Publish package to npmjs.com') {
87
- // when { environment name: 'BRANCH_NAME', value: 'main' }
87
+ when { environment name: 'BRANCH_NAME', value: 'main' }
88
88
  environment {
89
89
  NPM_TOKEN = credentials('npm-token')
90
90
  }
package/README.md CHANGED
@@ -1,9 +1,22 @@
1
- # SmartMet Alert Client (smartmet-alert-client)
1
+ # SmartMet Alert Client
2
2
 
3
3
  SmartMet Alert Client is a customizable map visualizer for weather, flood and other alerts.
4
4
 
5
5
  ![Screenshot](./screenshot.png)
6
6
 
7
+ ## Installation
8
+
9
+ ```
10
+ npm install @fmidev/smartmet-alert-client
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ```
16
+ <smartmet-alert-client language="en"></smartmet-alert-client>
17
+ ```
18
+ More examples are available in the directory `public`.
19
+
7
20
  ## Project setup
8
21
  ```
9
22
  npm install
@@ -23,12 +36,3 @@ npm run build
23
36
  ```
24
37
  npm run lint
25
38
  ```
26
-
27
- ### Localization
28
-
29
- The default language is defined in the .env file. This can be overridden when defining a Vue component:
30
- ```
31
- <template>
32
- <AlertClient :refreshInterval="refreshInterval" :selectedDay="selectedDay" language="en"/>
33
- </template>
34
- ```