From 83639ecb01208e06b33365eded3d185c9996f9c7 Mon Sep 17 00:00:00 2001
From: norohind <60548839+norohind@users.noreply.github.com>
Date: Tue, 19 Oct 2021 20:45:25 +0300
Subject: [PATCH] add README.md

---
 README.md     | 12 ++++++++++++
 example.jsonl |  1 +
 2 files changed, 13 insertions(+)
 create mode 100644 README.md
 create mode 100644 example.jsonl

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d087f00
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+Simple script to process `NavRoute` events from EDDN and store data about routes and systems from it.
+The script should be fed by entering jsonl events from EDDN to stdin (it makes Bravada's archives very easy to use.
+Thank you, Bravada), then script will fill with new data sqlite database `navroutes.sqlite`. 
+This DB contains three tables:
+1. `systems` - contains main information about systems.
+2. `systems_history` - contains history of `systems` changes.
+3. `routes` - contain routes.
+
+For more information you can examine `doc.txt` file, database itself or source code of the script.
+
+This repo contains `example.jsonl` - it is example of input data, to use it type `cat example.jsonl | python3 main.py`
+and check DB for results.
\ No newline at end of file
diff --git a/example.jsonl b/example.jsonl
new file mode 100644
index 0000000..8456c6f
--- /dev/null
+++ b/example.jsonl
@@ -0,0 +1 @@
+{"$schemaRef": "https://eddn.edcd.io/schemas/navroute/1", "header": {"softwareName": "E:D Market Connector [Windows]", "softwareVersion": "5.2.0-beta1", "uploaderID": "Aleksey31"}, "message": {"timestamp": "2021-10-18T17:09:18Z", "event": "NavRoute", "Route": [{"StarSystem": "Pleiades Sector HR-W d1-79", "SystemAddress": 2724879894859, "StarPos": [-80.625, -146.65625, -343.25], "StarClass": "F"}, {"StarSystem": "Maia", "SystemAddress": 8216113749, "StarPos": [-81.78125, -149.4375, -343.375], "StarClass": "B"}]}}