summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
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')
+```