From 57605cd1b843e0429db0396d3dc821e6579292fa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=A0est=C3=A1k=20V=C3=ADt?= <Vit.Sestak@ysoft.com>
Date: Fri, 31 Jan 2020 22:22:09 +0100
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..efe5047
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Indexer of Nuget packages
+
+This indexer can index Artifactory and Nexus repositories for Nuget packages. It allows you to search a Nuget package by a hash of some of its DLL file.
+
+The indexer works in batch – it scans what it can and then exits. It tries to scan only newly added Nugets. However, it relies on having good timestamps. You can run it periodically (i.e., polling) or on some event (e.g., Artifactory webhook or inotify event with Nexus).
+
+For Artifactory, it scans a remote server.
+
+For Nexus, it scans repository stored on local filesystem.
\ No newline at end of file