From 1ee9e6a42c4ab011699a1b40276d2ce4fd163ab6 Mon Sep 17 00:00:00 2001
From: InsanusMokrassar <ovsyannikov.alexey95@gmail.com>
Date: Sat, 12 Oct 2019 12:37:48 +0600
Subject: [PATCH] fill README

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4c189e5..298c336 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,25 @@
-# SauceNaoAPI
\ No newline at end of file
+# SauceNaoAPI
+
+It is wrapper for [SauceNAO](https://saucenao.com/) API. For now, library is
+in preview state. It can be fully used, but some of info can be unavailable from
+wrapper classes.
+
+## Requester
+
+For the requests we are using `SauceNaoAPI` object. Unfortunately, for now it
+supports only url strings as source of request. For example:
+
+```kotlin
+val key = // here must be your Sauce NAO API key
+val requestUrl = // here must be your link to some image
+
+val api = SauceNaoAPI(key)
+api.use {
+    println(
+        it.request(requestUrl)
+    )
+}
+```
+
+Most of others requests use the same etymology and meaning as in the
+`SauceNAO` API docs.