Docs:

- README.md for the main project which contains two quick setups for both flavors
  and refers to each.
- Adds complete docs for category style
- Updates the tests configs
  (essentially to verify the part about exposing the control logging
   works as advertised)

Author: mreuvers

README.md

@@ -0,0 +1,181 @@
+# 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.
+
+* The [typescript-logging-category-style](./category-style/README.MD) flavor
+* The [typescript-logging-log4ts-style](./log4ts-style/README.MD) flavor
+
+The following general sections are available:
+
+* [Getting started](#getting-started)
+* [Build](#build)
+* [Tests](#tests)
+* [Bugs](#bugs)
+* [Contributing](#contributing)
+* [Migration](#migration)
+* [Changelog](#changelog)
+
+## Getting started
+
+For all details and documentation please visit the links above. The following sections provide a quick start only for
+both flavors.
+
+### Category style flavor
+
+*To install the category-style flavor use the following npm command:*
+
+```shell
+npm install --save typescript-logging-category-style
+```
+
+*Usage*
+
+The following section configures a provider and exposes a getLogger function for other modules to use. The getLogger in
+this example is used to create root categories.
+
+```typescript
+/*--- LogConfig.ts ---*/
+import {CategoryProvider, Category} from "typescript-logging-category-style";
+
+const provider = CategoryProvider.createProvider("ExampleProvider");
+
+export function getLogger(name: string): Category {
+  return provider.getCategory(name);
+}
+```
+
+----
+
+```typescript
+/*--- Person.ts ---*/
+import {getLogger} from "./LogConfig";
+
+/* Root categories can and probably will be defined elsewhere, this is just an example */
+const logModel = getLogger("model");
+
+/* Create child categories based on a parent category, effectively allowing you to create a tree of loggers when needed */
+const logPerson = logModel.getChildCategory("Person");
+
+function example(value: string) {
+  logPerson.debug(() => `Example function called with value ${value}`);
+  try {
+    // Awesome code here...
+    logPerson.getChildCategory("example()").debug(() => "Child category again");
+  }
+  catch (e) {
+    logPerson.error(() => "Awesome code failed unexpectedly", e);
+  }
+  finally {
+    logPerson.debug(() => "Example function completed");
+  }
+}
+```
+
+### Log4ts flavor
+
+*To install the log4ts-style flavor use the following npm command:*
+
+```shell
+npm install --save typescript-logging-log4ts-style
+```
+
+*Usage*
+
+The following section configures a provider and exposes a getLogger function for other modules to use.
+
+```typescript
+/*--- LogConfig.ts ---*/
+import {Log4TSProvider, Logger, LogLevel} from "typescript-logging-log4ts-style";
+
+const provider = Log4TSProvider.createProvider("ExampleProvider", {
+  /* Specify the various group expressions to match against */
+  groups: [{
+    expression: new RegExp("model.+"),
+    level: LogLevel.Debug, /* This group will log on debug instead */
+  }, {
+    expression: new RegExp("service.+"),
+  }],
+});
+
+export function getLogger(name: string): Logger {
+  return provider.getLogger(name);
+}
+```
+
+----
+
+```typescript
+/*--- Person.ts ---*/
+import {getLogger} from "./LogConfig";
+
+const log = getLogger("model.Person")
+
+function example(value: string) {
+  log.debug(() => `Example function called with value ${value}`);
+  try {
+    // Awesome code here...
+  }
+  catch (e) {
+    log.error(() => "Awesome code failed unexpectedly", e);
+  }
+  finally {
+    log.debug(() => "Example function completed");
+  }
+}
+```
+
+## Build
+
+To locally build the logging flavors.
+
+```shell
+npm run ci                 # If not installed yet
+npm run build --workspaces # Builds all flavors, going into respective directory doing just 'npm run build' works too.
+```
+
+## Tests
+
+To locally run the tests:
+
+```shell
+npm run ci                # If not installed yet
+npm run test --workspaces # Tests all flavors, going into respective directory doing just 'npm run test' works too.
+```
+
+## Integration tests
+
+If you're on linux or mac-os, it's easiest to run initialize.sh first. Otherwise, skip that and run npm run ci manually
+as shown below.
+
+```shell
+# Linux/MacOS only - Cleans everything and re-installs packages, including those for the integration projects.
+./initialize.sh
+
+# Use when ./initialize.sh cannot be used
+npm run ci      # Run inside respective test-integration project, e.g. tests-integration/rollup
+npm run build   # Run inside respective test-integration project. Builds test webapp and runs cypress tests.
+```
+
+## Bugs
+
+If you encounter a bug please log it in the issue tracker of this repository.
+
+## Contributing
+
+Feel free to contribute or come up with great ideas, please use the issue tracker for that.
+
+If you add/change new functionality and want it merged in a later release, please open a pull request. Also add tests
+for it (see various "test" directories).
+
+Please keep in mind that things may not fit the library and in such case will be rejected, so if you are unsure please
+ask first before wasting your valuable time.
+
+# Migration
+
+Please check the [migration guide](documentation/migration.md) if you are on an old version and wish to use the latest
+version available.
+
+## Changelog
+
+Please check the [changelog](documentation/change_log.md)