more documentation updates

ctc-oss · Oct 6, 2023 · cd89ab8 · cd89ab8
1 parent 1df1c1b
commit cd89ab8
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -135,6 +135,8 @@ Node packages will be in `.tgz` files located at:
 /packages/client/omega-edit-node-client-${VERSION}.tgz
 ```
 
+More information about the node packages can be found in the [packages](packages/README.md) folder.
+
 ## Release Binaries
 
 [Binary releases](https://github.com/ctc-oss/omega-edit/releases) for macOS (Apple Silicon and x86), Windows (x86), and

diff --git a/packages/README.md b/packages/README.md
@@ -1,5 +1,7 @@
 # Ωedit™ Node Packages
 
+:exclamation: These commands should be executed in the `packages` folder after a successful [build](../README.md). :exclamation:
+
 This folder contains different node packages that will be created for `omega-edit`.  These packages are:
 
 * `@omega-edit/server` - The server package for `omega-edit`
@@ -13,8 +15,8 @@ local `node_modules` folder in the project that has Ωedit™ dependencies.  Her
 1. In the packages folder, run `yarn link`.
 
 ```bash
-pushd packages/server && yarn link && popd
-pushd packages/client && yarn link && popd
+yarn --cwd server link
+yarn --cwd client link
 ```
 
 2. In the project folder that you want to use the packages in, run `yarn link <package-name>`.  If the project uses npm,
@@ -36,6 +38,6 @@ yarn unlink @omega-edit/server @omega-edit/client
 5. You can also unlink the packages from the package folder by running `yarn unlink` in the package folder.
 
 ```bash
-pushd packages/server && yarn unlink && popd
-pushd packages/client && yarn unlink && popd
+yarn --cwd server unlink
+yarn --cwd client unlink
 ```
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@omega-edit/client",
   "version": "0.9.74",
-  "description": "OmegaEdit gRPC Client TypeScript Types",
+  "description": "OmegaEdit gRPC Client",
   "publisher": "ctc-oss",
   "main": "out/index.js",
   "types": "out/index.d.ts",

diff --git a/packages/client/src/dataMan.ts b/packages/client/src/dataMan.ts
diff --git a/packages/client/tests/specs/dataMan.spec.ts b/packages/client/tests/specs/dataMan.spec.ts
diff --git a/packages/server/package.json b/packages/server/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@omega-edit/server",
   "version": "0.9.74",
-  "description": "OmegaEdit gRPC Server TypeScript functions",
+  "description": "OmegaEdit gRPC Server",
   "publisher": "ctc-oss",
   "main": "out/index.js",
   "types": "out/index.d.ts",