From 35a35ab9b1e5f3a9d22a3add95f5a6e38eb48e85 Mon Sep 17 00:00:00 2001
From: Anatoly Kopyl <akopyl@radner.ru>
Date: Tue, 6 Apr 2021 18:58:12 +0300
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Added=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d473d73
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Dochunt
+
+An OSINT tool to run public vk documents though an OCR system.
+
+## Install:
+```sh
+git clone https://github.com/anatolykopyl/dochunt.git
+cd dochunt
+pip install -r requirements.txt
+```
+
+## Usage:
+
+1. Set up your credentials in `config.ini`.
+
+2. Set up whatever you're interested in in `config.ini` 
+in `interests`. This should be either a list of strings
+formatted like this:
+```ini
+interests = [
+    "interest1",
+    "interest2",
+    "interest3",
+    ...
+  ]
+```
+If the image contains any of these strings the script will save it.
+
+Or the word `any` to save any image containing text.
+```ini
+interests = any
+```
+
+3. Run the script 
+
+This will watch the latest uploaded document:
+```sh
+python main.py
+```
+This will go through all availible documents (vk caps search to 1000 latest docs):
+```sh
+python main.py -a
+```
+
+
+Inspired by [darkshot](https://github.com/mxrch/darkshot).
\ No newline at end of file