From 2dec2208e0903dea2591c75737714c3ea40167d5 Mon Sep 17 00:00:00 2001
From: dannc <dannc.sao@gmail.com>
Date: Thu, 21 Sep 2023 15:03:13 +0700
Subject: [PATCH] add readme

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a764fa4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+## Coverage merger
+
+Library/tool to merge two or more coverage files into single one.
+
+Supported formats:
+* clover
+* junit (todo)
+
+### Install
+
+// todo
+
+### Usage
+
+It's cli-app with single access point:
+
+```shell
+./merger
+```
+
+```text
+clover-merger, version 1.0.0
+
+Commands:
+*
+  clover    Merge clover coverage files into single one
+
+Run `<command> --help` for specific help
+```
+
+### Additional info
+
+Clover merge logic based on [d0x2f/CloverMerge](https://github.com/d0x2f/CloverMerge).