From 28bf1a59c6d8fbc73a04a795548ce34b0832aa85 Mon Sep 17 00:00:00 2001
From: Jaka Daneu <44704999+jalezi@users.noreply.github.com>
Date: Tue, 27 Apr 2021 09:04:43 +0200
Subject: [PATCH] + Readme

---
 Readme.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..941b987
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,21 @@
+# Sledilnik Screenshots
+
+Based on [SledilnikScreenshots](https://github.com/VesterDe/SledilnikScreenshots).
+
+Calling URL with appropriate query params will return `image/png` `base64` encoded.
+
+## Developing new screenshot
+
+Run `yarn` to install everything. You are now ready.
+
+Add your new screenshot settings into an appropriate key inside screenshots.js.
+
+In `test.js` set `query` variable to match your screenshot.
+
+Running `node test.js` should make your screenshot on your local machine.
+
+If you want to observe what is going on, set variable `headless` to `false`.
+
+## Deploying
+
+Just push to master, the code will be live about 60 seconds after that.