From f161d60d2d7aabbf150f4610507cedf512837555 Mon Sep 17 00:00:00 2001 From: Christopher Talib Date: Fri, 12 Jun 2020 12:04:59 +0200 Subject: [PATCH] Adding a small abstract to README --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d56a4f1..6da602c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ # Styx -## IMPORTANT +## What are we trying to solve -For development purposes, each time you restart Styx, the database and the -schema is dropped. Currently, this is hardcoded and used to make development -easier. Just so you know. +Styx is the passive sibling of Vader. When Vader allows users to get "on-demand" +data from connectors, Styx will just ingest streams and streams of data. Styx +will find things when they are happening on the contrary of retro-hunting, Styx +find patterns in the current events and flags them on the spot. It's not +retro-hunting, it's present-hunting or even future-hunting as we hope to find +actors movement when they happen. ## Prerequisites Styx uses a couple of other services to run: -* Kafka for messaging (not implemented yet in the docker, but currently not - necessary) +* Kafka for messaging (not implemented yet in the docker, but currently not necessary) * Dgraph for graph representation of results * Docker-compose to launch everything @@ -35,7 +37,7 @@ docker run --rm -it -p 8080:8080 -p 9080:9080 -p 8000:8000 -v ~/dgraph:/dgraph d go get -u gitlab.dcso.lolcat/LABS/styx cd $GOPATH/src/gitlab.dcso.lolcat/LABS/styx go build -docker-compose up -d # or the other command +docker-compose up -d # or the other docker command ./styx ```