Merge pull request #71 from PlanBGmbH/docs/29-write-a-meaningful-readme

📝 Wrote a meaningful readme

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 PlanB. GmbH
+Copyright (c) 2021 - 2022 PlanB. GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,49 @@
 # flinkey Web Components
-This project provides some Web Components built for usage in combination with the flinkey API.
+
+[![Build & Publish Package](https://github.com/PlanBGmbH/flinkey-web-components/actions/workflows/Build_Publish.yml/badge.svg)](https://github.com/PlanBGmbH/flinkey-web-components/actions/workflows/Build_Publish.yml) [![npm version](https://badge.fury.io/js/@planbgmbh%2Fflinkey-web-components.svg)](https://badge.fury.io/js/@planbgmbh%2Fflinkey-web-components) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Table of contents
+
+- [Introduction](#introduction)
+- [Getting started](#getting-started)
+- [Contributing](#contributing)
+- [Versioning](#versioning)
+- [License](#license)
+
+
+## Introduction
+
+This project provides some [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) built for usage in combination with the [flinkey API](https://developers.flinkey.com/api/v3/getting-started/). The reason to build these collection of [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) was that some functionality is provided via [flinkey API](https://developers.flinkey.com/api/v3/getting-started/) only but there is no pre-built UI for that functionality anywhere. Therefore each customer of WITTE Digital needs to build their own UI that consumes these specific endpoints.
+
+## Getting started
+
+### Installation
+
+```shell
+npm install @planbgmbh/flinkey-web-components
+```
+
+### Usage example
+
+```ts
+Globals.customerId = 1;
+Globals.apiKey = 'SomeApiKey';
+Globals.token = 'ey123';
+Globals.apiBaseUrl = 'https://api.flinkey.de/v3';
+```
+
+```html
+<flinkey-keyfob-catalog></flinkey-keyfob-catalog>
+```
+
+## Contributing
+
+Please read through our [contributing guidelines](./CONTRIBUTING.md).
+
+## Versioning
+
+Maintained under the [Semantic Versioning guidelines](https://semver.org/).
+
+## License
+
+[License](./LICENSE)