added package documentation

This commit is contained in:
Annika Hannig 2022-02-28 14:36:33 +00:00
parent 2be8d9e23c
commit fe42b38eb6
No known key found for this signature in database
GPG Key ID: 62E226E47DDCE58D
4 changed files with 15 additions and 0 deletions

View File

@ -0,0 +1,6 @@
// Package postgres is an implementation of a routes and neighbors
// store using the postgres database.
//
// Routes and neighbors are stored as jsonb information
// with indexes for query performance.
package postgres

View File

@ -113,6 +113,7 @@ func TestGetNeighbors(t *testing.T) {
if err == nil {
t.Error("Unknown source should have yielded zero results")
}
t.Log(neighbors)
}

8
pkg/store/package.go Normal file
View File

@ -0,0 +1,8 @@
// Package store provides an interface for keeping
// routes and neighbor information without querying
// a route server. The refresh happens in a configurable
// interval.
//
// There a currently two implementations: A postgres and
// and in-memory backend.
package store