From ab712aaeadd08f068f52c1d193174a5d80a025f7 Mon Sep 17 00:00:00 2001
From: pietervdvn <pietervdvn@posteo.net>
Date: Thu, 4 Feb 2021 11:54:56 +0100
Subject: [PATCH] Update readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 03b9e5c..5451e83 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,16 @@
 # AspectedRouting
+
 Building routing profiles easily
+
+## What is aspected routing
+
+Aspected routing is a system where routeplanning factors are constructed in multiple steps.
+
+First, there are "aspects", which convert a set of attributes into some value (a number, a boolean, a string) - a function of `Tags -> a` basically.
+These are grouped together in a `profile`, which uses these functions to state the behaviour - e.g. wether the vehicle can enter a way, can go both ways or just a single way, how fast it would realistically go, and finally how 'optimal' the road is.
+
+## Using AspectedRouting
+
+At the moment, this project takes in a collection of `.json`-files and converts them into a `.lua`-script which is compatible with [Itinero 1.0](https://github.com/itinero/routing) and  [Itinero 2.0](https://github.com/itinero/routing2)
+
+PR's to support other systems (e.g. OsmAnd) are welcome. However, keep in mind that we will not be able to _maintain_ them for you.