From 06d9e7837dda38c9ee4ee19a5c01796da7a347c0 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Thu, 15 Mar 2018 14:32:56 +0200
Subject: Update files

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 85d821b..8c7422a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,30 @@
 # Redisearch Wikipedia Test
+
+## Prerequisites
+
+ - Redis server
+ - A compiled `redisearch.so` module
+ - Python 3 virtual env `pip install -r requirements.txt`
+
+## Usage
+
+Run Redis server
+
+```bash
+$ redis-server --loadmodule /path/to/redisearch.so
+```
+
+Load random articles from wikipedia (infinite loop, kill the process once you have enough):
+
+```bash
+$ python load_random.py
+```
+
+Search the index:
+
+```python
+from redisearch import Client
+
+c = Client('wikipedia')
+c.search('search term')
+```
-- 
cgit v1.3.1