Merge pull request #1 from NUWCDIVNPT/rc-1

feat: initial public offering

.github/workflows/unit-testing.yml

@@ -0,0 +1,42 @@
+name: Unit Tests and coverage report
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+        - main
+    paths:
+        - "ReviewParser.js"
+        - "TaskObject.js"
+        - "test/**"
+        - "WATCHER-test-files/**"
+  pull_request:
+    branches:
+        - main
+    paths:
+        - "ReviewParser.js"
+        - "TaskObject.js"
+        - "test/**"
+        - "WATCHER-test-files/**"
+
+jobs:
+  build_test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Setup Node.js 
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - name: Install app dependencies
+      run: npm ci
+    - name: Run tests
+      run: npm test
+    - name: Upload coverage to github
+      uses: actions/upload-artifact@v3
+      if: ${{ always() }}
+      with:
+        name: coverage
+        path: coverage
+

.gitignore

@@ -0,0 +1,4 @@
+index.cjs
+coverage/
+node_modules/
+.vscode/*

README.md

@@ -1,2 +1,56 @@
 # stig-manager-client-modules
-ES and CJS modules for STIG Manager clients
+JavaScript modules for STIG Manager clients. This README and other documentation is under construction.
+
+## Using the modules in Node.js
+In the root of a project, open a terminal and execute:
+
+```
+$ npm install git+https://github.com/nuwcdivnpt/stig-manager-client-modules#rc-1
+```
+
+Importing all modules into ESM code
+
+```
+import * as StigmanLib from `stig-manager-client-modules`
+
+const result = StigmanLib.reviewsFromCkl( ... )
+const result = StigmanLib.reviewsFromCklb( ... )
+const result = StigmanLib.reviewsFromXccdf( ... )
+
+const tasks = new StigmanLib.TaskObject ( ... )
+
+```
+
+Importing an individual module into ESM code
+
+```
+import { reviewsFromCkl } from `stig-manager-client-modules`
+const result = reviewsFromCkl( ... )
+```
+
+Requiring all modules into CJS code
+
+```
+const StigmanLib = require('stig-manager-client-modules')
+
+const result = StigmanLib.reviewsFromCkl( ... )
+const result = StigmanLib.reviewsFromCklb( ... )
+const result = StigmanLib.reviewsFromXccdf( ... )
+
+const tasks = new StigmanLib.TaskObject ( ... )
+```
+
+Requiring an individual module into CJS code
+```
+const { reviewsFromCkl } = require('stig-manager-client-modules')
+
+const result = reviewsFromCkl( ... )
+```
+
+## 
+
+
+
+
+
+