From 7367f43dd47cca9926d918c6eaa7b3283e0ce54f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Konstantin=20Gru=CC=88ndger?= Date: Sun, 6 Jan 2019 20:37:20 +0100 Subject: [PATCH] Better TimescaleDB description --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c0912e..fa7ae5b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ A database backend for the [Open Glider Network](http://wiki.glidernet.org/). The ogn-python module saves all received beacons into a database with [SQLAlchemy](http://www.sqlalchemy.org/). It connects to the OGN aprs servers with [python-ogn-client](https://github.com/glidernet/python-ogn-client). -It requires [TimescaleDB](https://www.timescale.com, based on PostgreSQL) and [PostGIS](http://www.postgis.net/). +It requires [PostgreSQL](http://www.postgresql.org/) and [PostGIS](http://www.postgis.net/). +For best performance you should use [TimescaleDB](https://www.timescale.com), which is based on PostgreSQL. [Examples](https://github.com/glidernet/ogn-python/wiki/Examples) @@ -39,6 +40,12 @@ It requires [TimescaleDB](https://www.timescale.com, based on PostgreSQL) and [P ./manage.py db.init ``` +6. Optional: Prepare tables for TimescaleDB + + ``` + ./manage.py db.init_timescaledb + ``` + There is also a [Vagrant](https://www.vagrantup.com/) environment for the development of ogn-python. You can create and start this virtual machine with `vagrant up` and login with `vagrant ssh`. The code of ogn-python will be available in the shared folder `/vagrant`.