Document version and revision

playcanvas · Jan 21, 2024 · ef621ef · ef621ef
1 parent 3f6c9a9
commit ef621ef
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/index.ts b/src/index.ts
@@ -12,8 +12,14 @@
 export * from './binding';
 export * from './components';
 
-// these strings are set by the build script
+/**
+ * The version of the PCUI library. This is a string in semantic version format of `major.minor.patch`.
+ */
 const version = 'PACKAGE_VERSION';
+
+/**
+ * The git revision of the PCUI library. This is a string of the git commit hash.
+ */
 const revision = 'PACKAGE_REVISION';
 
 export { version };