@commversion/libs 0.0.1-alpha.1 → 0.0.1-alpha.2
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 +41 -2
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -1,2 +1,41 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
1
|
+
# Commversion public facing libraries
|
|
2
|
+
|
|
3
|
+
A set of Commversion's public facing scripts and utilities.
|
|
4
|
+
|
|
5
|
+
## Installation & Configuration
|
|
6
|
+
|
|
7
|
+
The library is distributed as a public facing npm package.
|
|
8
|
+
|
|
9
|
+
The recommended way to install this on a website is through JsDelivr.com.
|
|
10
|
+
|
|
11
|
+
```html
|
|
12
|
+
<script src="https://cdn.jsdelivr.net/npm/@commversion/libs@0.0.1-alpha.1/dist/schedule-event.js"></script>
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Configuration
|
|
16
|
+
|
|
17
|
+
Configuration takes place by global `window.commversion` object, make sure to not overwrite it if it already exists!
|
|
18
|
+
|
|
19
|
+
```html
|
|
20
|
+
<script>
|
|
21
|
+
window.commversion = window.commversion || {};
|
|
22
|
+
window.commversion.someProperty = true;
|
|
23
|
+
</script>
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Release new versions
|
|
27
|
+
|
|
28
|
+
The project follows the semantic versioning convention.
|
|
29
|
+
|
|
30
|
+
Patch releases for bug fixes.
|
|
31
|
+
Minor releases for new features.
|
|
32
|
+
Major releases for breaking changes.
|
|
33
|
+
|
|
34
|
+
The release is fully automated by executing `npm release`.
|
|
35
|
+
|
|
36
|
+
## Guideline for contributing
|
|
37
|
+
|
|
38
|
+
WIP.
|
|
39
|
+
This will be updated soon.
|
|
40
|
+
|
|
41
|
+
Short version, new packages go in `packages/` directory and vite configuration is required.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@commversion/libs",
|
|
3
|
-
"version": "0.0.1-alpha.
|
|
3
|
+
"version": "0.0.1-alpha.2",
|
|
4
4
|
"author": "Marios Antonoudiou <mariosant@sent.com>",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"scripts": {
|
|
@@ -9,7 +9,9 @@
|
|
|
9
9
|
"prepack": "concurrently yarn:build:*",
|
|
10
10
|
"release": "release-it",
|
|
11
11
|
"dev:schedule-event": "vite serve packages/schedule-event/src/",
|
|
12
|
-
"build:schedule-event": "vite build -c packages/schedule-event/vite.config.js"
|
|
12
|
+
"build:schedule-event": "vite build -c packages/schedule-event/vite.config.js",
|
|
13
|
+
"dev:lc-ga-tags": "vite serve packages/lc-ga-tags/src/",
|
|
14
|
+
"build:lc-ga-tags": "vite build -c packages/lc-ga-tags/vite.config.js"
|
|
13
15
|
},
|
|
14
16
|
"publishConfig": {
|
|
15
17
|
"access": "public"
|