adding normal fucking readme

license

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kolyma's Laboratory
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readme.md

@@ -0,0 +1,80 @@
+<p align="center">
+    <img src=".github/assets/header.png" alt="Kolyma's {Kerio}">
+</p>
+
+<p align="center">
+    <h3 align="center">Kerio wrap-up for NixOS.</h3>
+</p>
+
+<p align="center">
+    <img align="center" src="https://img.shields.io/github/languages/top/kolyma-labs/kerio?style=flat&logo=nixos&logoColor=ffffff&labelColor=242424&color=242424" alt="Top Used Language">
+    <a href="https://github.com/kolyma-labs/kerio/actions/workflows/test.yml"><img align="center" src="https://img.shields.io/github/actions/workflow/status/kolyma-labs/kerio/test.yml?style=flat&logo=github&logoColor=ffffff&labelColor=242424&color=242424" alt="Test CI"></a>
+</p>
+
+## About
+
+A company where the maintainer works require its workers to use Kerio Connect to access servers via ssh. Therefore, creating Kerio Connect
+port for NixOS was necessary.
+
+> Using Kerio in company should be illegal && crime!
+
+## Features
+
+- Reproducible Kerio Connect configurations
+- Makes use of 24.05
+
+## Running package
+
+You can run the package by using the following command:
+
+```shell
+nix run github:kolyma-labs/kerio --impure
+```
+
+## Installing package
+
+You should add this repository to your config flake inputs:
+
+```nix
+# Kerio Control Access
+kerio = {
+  url = "github:kolyma-labs/kerio";
+  inputs.nixpkgs.follows = "nixpkgs";
+  flake = true;
+};
+```
+
+
+Then, modify your `pkgs` instance to include `kerio` package by adding overlay:
+
+```nix
+# Bind the kerio packages over pkgs.kerio
+kerio-additions = final: _prev: {
+  kerio = import inputs.kerio {
+    system = final.system;
+    config.allowUnfree = true;
+  };
+};
+```
+
+Finally, you can include kerio in your global system packages:
+
+```nix
+# Adding kerio control vpn
+environment.systemPackages = [
+  pkgs.kerio # .kerio-control-vpnclient
+];
+```
+
+## Thanks
+
+- [Tony Finn](https://tonyfinn.com/blog/arch-packages-with-nix/) - For awesome tutorial on converting arch package to nix
+- [Nix](https://nixos.org/) - Masterpiece of package management
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](license) file for details.
+
+<p align="center">
+    <img src=".github/assets/footer.png" alt="Kolyma's {Kerio}">
+</p>