Added README for topologies

SpamScope · Apr 12, 2018 · e93a678 · e93a678
1 parent 2788a55
commit e93a678
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/docs/images/schema_spamscope_debug.png b/docs/images/schema_spamscope_debug.png
diff --git a/docs/images/schema_spamscope_elasticsearch.png b/docs/images/schema_spamscope_elasticsearch.png
diff --git a/docs/images/schema_spamscope_redis.png b/docs/images/schema_spamscope_redis.png
diff --git a/topologies/README.md b/topologies/README.md
@@ -0,0 +1,18 @@
+# Overview
+In this folder there are all SpamScope topologies.
+You will see that all topologies are same, except that changes where you store the JSON results.
+
+# spamscope_debug
+In this topology the results are stored on file system. 
+
+![Schema spamscope_debug](docs/images/schema_spamscope_debug.png?raw=true "Schema spamscope_debug")
+
+# spamscope_elasticsearch
+In this topology the results are stored in Elasticsearch. 
+
+![Schema spamscope_elasticsearch](docs/images/schema_spamscope_elasticsearch.png?raw=true "Schema spamscope_elasticsearch")
+
+# spamscope_redis
+In this topology the results are stored in Redis. 
+
+![Schema spamscope_redis](docs/images/schema_spamscope_redis.png?raw=true "Schema spamscope_redis")