@sedoo/unidoo 0.1.8 → 0.1.9
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/README.md +9 -12
- package/dist/unidoo.common.js.map +1 -1
- package/dist/unidoo.umd.js.map +1 -1
- package/dist/unidoo.umd.min.js.map +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# unidoo
|
|
2
2
|
|
|
3
|
-
see [Documentation](https://sedoo.
|
|
3
|
+
see [Documentation](https://sedoo.pages.in2p3.fr/unidoo)
|
|
4
4
|
|
|
5
5
|
## Library
|
|
6
6
|
|
|
@@ -25,14 +25,17 @@ Vue.use(Unidoo)
|
|
|
25
25
|
|
|
26
26
|
### Warning
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Naming convention: the main branch is called *main* and not *master*
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
### How to publish the library in NPM ?
|
|
32
32
|
|
|
33
|
-
The publishing
|
|
33
|
+
The publishing of the library is automated. No other method should be used.
|
|
34
|
+
|
|
35
|
+
After each `git push --tags`:
|
|
36
|
+
- the documentation of the library is built and deployed as a gitlab page
|
|
37
|
+
- the library is built and deployed to [@sedoo/unidoo](https://www.npmjs.com/package/@sedoo/unidoo) npm registry
|
|
34
38
|
|
|
35
|
-
After each push on the *main* branch, a build is launched.
|
|
36
39
|
If the build is successful, the system will publish it on NPM using the version number indicated in the *package.json* file.
|
|
37
40
|
If this version corresponds to an already published version, the build will stop here. Else, the version is published.
|
|
38
41
|
|
|
@@ -45,15 +48,9 @@ Hence, to publish an new version, it is important to modify the number in the *p
|
|
|
45
48
|
To run the demo locally:
|
|
46
49
|
|
|
47
50
|
```shell
|
|
48
|
-
npm run
|
|
51
|
+
npm run docs:dev
|
|
49
52
|
```
|
|
50
53
|
|
|
51
|
-
### Publishing of the online application
|
|
52
|
-
|
|
53
|
-
The publishing of the library is an automated mechanism based on Github workflow system. No other method should be used.
|
|
54
|
-
After each push on the *main* branch, the online application is launched.
|
|
55
|
-
|
|
56
|
-
|
|
57
54
|
## Demonstration
|
|
58
55
|
|
|
59
|
-
[Live demonstration](https://sedoo.
|
|
56
|
+
[Live demonstration](https://sedoo.pages.in2p3.fr/unidoo)
|