Merge pull request #4 from Rooster212/update-readme-and-use-package-lock

Update README, use package-lock.json

Author: Rooster212

README.md

@@ -13,3 +13,18 @@ See blog posts:
 * https://adrianhesketh.com/2020/08/28/event-sourced-dynamodb-design-with-typescript-part-1/
 * https://adrianhesketh.com/2020/08/28/event-sourced-dynamodb-design-with-typescript-part-2/
 
+## Using a package from the GitHub Package registry for NPM
+
+There is full documentation [on the GitHub website here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package). Using the package hosted on GitHub requires setting up an `.npmrc` file for the project's scope in the consuming project that looks like this:
+
+```bash
+@rooster212:registry=https://npm.pkg.github.com
+```
+
+You also have to login to the GitHub package registry (as this is a public package, it should work for anyone).
+
+```bash
+npm login --scope=@rooster212 --registry=https://npm.pkg.github.com
+```
+
+If you use MFA on your GitHub account, you will need to setup a Personal Access Token in your profile settings and use that in place of your password when prompted in the `npm login` step.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rooster212/event-driven-dynamodb-rules-engine",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Events and rules engine for use with DynamoDB.",
   "main": "index.js",
   "scripts": {

publish.sh

@@ -8,6 +8,7 @@ mkdir ./dist
 npx tsc --project tsconfig.build.json
 
 cp package.json ./dist
+cp package-lock.json ./dist
 cp LICENSE.txt ./dist
 cd ./dist