docs: adding readme

Author: lotyp

README.md

@@ -1 +1,46 @@
-work in progress
+
+
+<br>
+
+<div align="center">
+<img width="456" src="https://raw.githubusercontent.com/wayofdev/laravel-cycle-orm-adapter/master/assets/logo.gh-light-mode-only.png#gh-light-mode-only">
+<img width="456" src="https://raw.githubusercontent.com/wayofdev/laravel-cycle-orm-adapter/master/assets/logo.gh-dark-mode-only.png#gh-dark-mode-only">
+</div>
+
+
+<br>
+
+<br>
+
+<div align="center">
+<a href="https://github.com/wayofdev/laravel-cycle-orm-adapter/actions"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fwayofdev%2Flaravel-cycle-orm-adapter%2Fbadge&style=flat-square"/></a>
+<a href="https://packagist.org/packages/wayofdev/laravel-cycle-orm-adapter"><img src="https://img.shields.io/packagist/dt/wayofdev/laravel-cycle-orm-adapter?&style=flat-square" alt="Total Downloads"></a>
+<a href="https://packagist.org/packages/wayofdev/laravel-cycle-orm-adapter"><img src="https://img.shields.io/packagist/v/wayofdev/laravel-cycle-orm-adapter?&style=flat-square" alt="Latest Stable Version"></a>
+<a href="https://packagist.org/packages/wayofdev/laravel-cycle-orm-adapter"><img src="https://img.shields.io/packagist/l/wayofdev/laravel-cycle-orm-adapter?style=flat-square&color=blue" alt="Software License"/></a>
+<a href="https://packagist.org/packages/wayofdev/laravel-cycle-orm-adapter"><img alt="Commits since latest release" src="https://img.shields.io/github/commits-since/wayofdev/laravel-cycle-orm-adapter/latest?style=flat-square"></a>
+<a href="https://app.codecov.io/gh/wayofdev/laravel-cycle-orm-adapter"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/wayofdev/laravel-cycle-orm-adapter?style=flat-square"></a>
+</div>
+
+<br>
+
+# Laravel Cycle ORM Adapter
+
+Package fully integrates [Cycle ORM](https://cycle-orm.dev) into Laravel and Lumen frameworks.
+
+If you **like/use** this package, please consider **starring** it. Thanks!
+
+<br>
+
+## 💿 Installation
+
+### → Using composer
+
+Require as dependency:
+
+```bash
+$ composer req wayofdev/laravel-cycle-orm-adapter
+```
+
+<br>
+
+! work-in-progress !