From 7a9629efe76d42ff67e0bf53bf8d15ab6cb5d6de Mon Sep 17 00:00:00 2001
From: ghost <localhost>
Date: Mon, 12 Feb 2024 00:11:12 +0200
Subject: [PATCH] update readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37b6cf3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# KVAZAR (webapp)
+
+[KevaCoin](https://github.com/kevacoin-project/) content Explorer written on [Symfony](https://github.com/symfony) and uses [Manticore](https://github.com/manticoresoftware) for full-text search.
+
+This project is new generation of [MySQL](https://github.com/kvazar-network/webapp/tree/mysql) and [SQLite](https://github.com/kvazar-network/webapp/tree/sqlite) implementations.
+
+Master branch currently under development!
+
+## Install
+
+* `git clone https://github.com/kvazar-network/webapp.git`
+* `cd webapp`
+* `composer install`
+
+## Setup
+
+* Web application requires RPC connection to KevaCoin node
+* Manticore search server must be installed also (application uses `php-pdo` driver to interact search index)
+* Configure crontab task to update search index: `* * * * * /crontab/index`
+
+## Launch
+
+* `symfony server:start`
\ No newline at end of file