From 29ff47733f52f3c1d3636d1256380403739f8adf Mon Sep 17 00:00:00 2001
From: George <horhik@tuta.io>
Date: Thu, 10 Feb 2022 11:44:55 +0300
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5a24849
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# timecode-generator 
+A simple Haskell script for creating timecodes by tracking changes in remote Markdown file
+
+**Requimpments**
+- Nix package manager installed
+## Installing
+Clone repository and run `nix-build -A pkgs.haskell.packages.ghc8107.timecode-generator` inside directory
+
+You'll find binary in `./result/bin/timecode-generator`
+#### In nix-shell
+run `nix-shell` and then compile it with cabal inside (`cabal build timecode-generator`)
+
+## how to use
+`./timecode-generator <URL to fetch> <Timecode filename>`