Fix readme for v1.2 changes

Author: SteveDesmond-ca

.github/workflows/npm.yml

@@ -28,6 +28,9 @@ jobs:
         run: yarn test
         working-directory: core
 
+      - name: Copy Readme
+        run: cp README.md core
+
       - name: Publish
         uses: JS-DevTools/npm-publish@v1
         with:

.gitignore

@@ -5,7 +5,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
-
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
@@ -103,11 +102,13 @@ dist
 # TernJS port file
 .tern-port
 
+.idea/
+.jekyll-cache/
+.scannerwork/
 .vscode/
 .vs/
 bin/
 obj/
-.idea/
-.scannerwork
-/docs/_site
-.jekyll-cache
+docs/_site/
+
+core/README.md

README.md

@@ -123,6 +123,7 @@ Please be sure to read and follow ecoAPM's [Contribution Guidelines](CONTRIBUTIN
 
 ### Building / Testing locally
 
+From the `core` directory:
 1. `npm install` or `yarn install` to download all dependencies
 2. `npm run build` or `yarn build` will compile `xunit.ts` and its tests to the `dist` directory
 3. `npm run test` or `yarn test` will run all unit tests in `dist/tests`
@@ -131,6 +132,6 @@ Please be sure to read and follow ecoAPM's [Contribution Guidelines](CONTRIBUTIN
 ### Missing an assertion?
 
 Create an issue or submit a pull request!
-1. Add a new function to `src/Assertions`
-2. Add tests for both the positive and negative cases in `tests/Assertions`
-3. Add a field for the assertion to `src/Assertions/index.ts`
+1. Add a new function to `core/src/Assertions`
+2. Add tests for both the positive and negative cases in `core/tests/Assertions`
+3. Add a field for the assertion to `core/src/Assertions/index.ts`

core/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "xunit.ts",
-	"version": "1.2.0",
+	"version": "1.2.1",
 	"description": "A unit testing framework for TypeScript, following standard xUnit patterns",
 	"main": "dist/xunit.js",
 	"author": "ecoAPM LLC",
@@ -37,4 +37,4 @@
 	"bin": {
 		"xunit": "dist/cli.js"
 	}
-}
+}