webdaemon 11.4.3 → 11.5.1

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 ADDED
@@ -0,0 +1,28 @@
1
+ # Web Daemon Library
2
+
3
+ The source files in `js` and `ts` are re-exported in `./index.js` which defines what
4
+ global classes and functions are available in the library.
5
+
6
+ The library contains both browser-side symbols such as `BrowserApp` and agent-side symbols
7
+ such as `Lifecycle`. Some symbols, such as `Token`, are used by both sides of an app.
8
+
9
+ ## Build
10
+ The library is distributed using `npm`, as a single bundled Javascript file in `dist/index.js`.
11
+
12
+ Build the distributable library using the toplevel `make npm` target, optionally providing the
13
+ semantic version number:
14
+
15
+ - `make npm`
16
+ - Builds the library with version `0.0.0-timestamp`
17
+ - Useful for interim and development releases.
18
+ - `VERSION=14.3.2 make npm`
19
+ - Builds the library with the given version number.
20
+ - Version must be `major.minor.patch`, where the `major.minor` must match the deployed
21
+ tabserver version.
22
+ - `make npm_publish`
23
+ - Publishes the previously build library on `npm` under its version number.
24
+
25
+ Use `npm view webdaemon` to view published versions.
26
+
27
+ Note that `npm` does not allow replacement of previously published versions, hence the use
28
+ of the special version `0.0.0-timestamp` for dev and trial purposes.