Finishing touches.

Add npm publish task.

Make the peerDependencies depend on 2.0.x.

Last touch to readme.

Author: mreuvers

.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to NPM
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies, build and test. 🔧
+        run: ./build.sh
+      - name: Publish typescript-logging (core) 📦
+        run: |
+          cd core
+          npm publish
+      - name: Publish typescript-logging (category-style) 📦
+        run: |
+          cd category-style
+          npm publish
+      - name: Publish typescript-logging (log4ts-style) 📦
+        run: |
+          cd log4ts-style
+          npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,7 +1,11 @@
 # TypeScript Logging
 
-TypeScript logging can be used to add logging to your web or node project. There are two different flavors available to
-use. Please visit either of these below and pick the one you prefer.
+TypeScript logging can be used to add logging to your web or node project.
+
+**_Version 2 of typescript-logging has been released, this version has been written from scratch and is
+not compatible with version 1 (see migration)._**
+
+There are two different flavors available to use. Please visit the documentation below and pick the one you prefer.
 
 * The [typescript-logging-category-style](./category-style/README.MD) flavor.
 * The [typescript-logging-log4ts-style](./log4ts-style/README.MD) flavor.
@@ -188,8 +192,8 @@ npm run build   # Run inside respective test-integration project. Builds test we
 
 ## Bugs
 
-If you encounter a bug please log it in the issue tracker of this repository and make sure what flavor (style) you are
-using.
+If you encounter a bug please log it in the issue tracker of this repository and make sure to specify what flavor 
+(style) you are using.
 
 ## Contributing
 

category-style/package.json

@@ -44,7 +44,7 @@
   },
   "homepage": "https://github.com/vauxite-org/typescript-logging/#readme",
   "peerDependencies": {
-    "typescript-logging": "2.0.0"
+    "typescript-logging": "2.0.x"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "21.0.1",

core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typescript-logging",
   "version": "2.0.0",
-  "description": "TypeScript Logging core written in and to be used by TypeScript (this is the core project, you want to use a flavor instead).",
+  "description": "TypeScript Logging core written in and to be used by TypeScript (this is the core project, you need to install a flavor too).",
   "main": "dist/bundle/typescript-logging.js",
   "module": "dist/bundle/typescript-logging.esm.js",
   "typings": "dist/bundle/src/typescript/main/typescript-logging.d.ts",

log4ts-style/package.json

@@ -42,7 +42,7 @@
   },
   "homepage": "https://github.com/vauxite-org/typescript-logging/#readme",
   "peerDependencies": {
-    "typescript-logging": "2.0.0"
+    "typescript-logging": "2.0.x"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "21.0.1",