minor fixes

Author: berislavlopac

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+Contributing Guidelines
+=========
+
+## Development Environment
+
+[Poetry](https://python-poetry.org) is used for dependency and package management. The steps for setting up the development environment:
+
+1. Install Poetry: either [globally](https://python-poetry.org/docs/#installation), or in a Python virtual environment (using `pip install poetry`).
+
+3. Install the project (if outside a virtual environment, Poetry will create one):
+
+        $ poetry install
+
+
+### Development Checks
+
+During development, a number of checks and tests can be executed on the library codebase:
+
+```shell
+$ pylint unclogger/                                  # code linting
+$ mypy --install-types --non-interactive unclogger/  # Python typing analysis
+$ black --check .                                    # Python code formatting
+$ isort --check .                                    # Import statement optimisation
+$ pydocstyle unclogger/                              # styling and completeness of docstrings  
+```
+
+Unit tests can be executed using:
+
+```shell
+$ pytest --cov --spec
+```
+
+The indicated options add extra details to the report:
+
+* `--cov` adds a test coverage report
+* `--spec` formats the test report as a list of spec statementss
+
+
+## API Documentation
+
+The project documentation can be served locally by running:
+
+```shell
+$ mkdocs serve
+```
+
+To build the static documentation site, run:
+
+```shell
+$ mkdocs build
+```
+
+This will create the HTML documentation in the `site` directory.

README.md

@@ -1,56 +1,24 @@
 Unclogger
 =========
 
-Simple library for customisable structured logging.
+Simple Python library for customizable structured logging.
 
+## Quick Intro
 
-## Development Environment
-
-[Poetry](https://python-poetry.org) is used for dependency and package management. The steps for setting up the development environment:
-
-1. Install Poetry: either [globally](https://python-poetry.org/docs/#installation), or in a Python virtual environment (using `pip install poetry`).
-
-3. Install the project (if outside a virtual environment, Poetry will create one):
-
-        $ poetry install
-
-
-### Development Checks
-
-During development, a number of checks and tests can be executed on the library codebase:
-
-```shell
-$ pylint unclogger/                                  # code linting
-$ mypy --install-types --non-interactive unclogger/  # Python typing analysis
-$ black --check .                                    # Python code formatting
-$ isort --check .                                    # Import statement optimisation
-$ pydocstyle unclogger/                              # styling and completeness of docstrings  
-```
-
-Unit tests can be executed using:
-
-```shell
-$ pytest --cov --spec
-```
-
-The indicated options add extra details to the report:
-
-* `--cov` adds a test coverage report
-* `--spec` formats the test report as a list of spec statementss
-
-
-## API Documentation
-
-The project documentation can be served locally by running:
-
-```shell
-$ mkdocs serve
+ ```python
+from unclogger import get_logger
+logger = get_logger("test logger")
+logger.info("test test", foo="abc", bar=123)
 ```
 
-To build the static documentation site, run:
-
-```shell
-$ mkdocs build
+Output:
+```json
+{
+  "foo": "abc", 
+  "bar": 123, 
+  "event": "test test", 
+  "logger": "test logger", 
+  "level": "info", 
+  "timestamp": "2021-02-12T22:40:07.600385Z"
+}
 ```
-
-This will create the HTML documentation in the `site` directory.

docs/index.md

@@ -105,7 +105,7 @@ Each logger has a local context; values can be bound to it so they can appear in
 
 ## Global Context
 
-The [`context_bind`](reference.md#uncloggerloggercontext_bind) function will set values in the global context, where it can be used by any logger.
+The [`context_bind`](reference.md#uncloggerloggercontext_bind) function will set values in the global context, where they can be used by any logger.
 
 !!! Example
 

pyproject.toml

@@ -1,10 +1,10 @@
 [tool.poetry]
 name = "unclogger"
 repository = "https://github.com/berislavlopac/unclogger"
-version = "0.1.1"
+version = "0.1.2"
 description = "Custom wrapper for enhanced structured logging."
 authors = ["Berislav Lopac <[email protected]>"]
-readme = "README.md"
+readme = "docs/index.md"
 
 [tool.poetry.dependencies]
 python = "^3.8"

release-notes/0.1.2.md

@@ -0,0 +1,3 @@
+* minor fixes
+* update README
+* introduce CONTRIBUTION guidelines