From 04c829b279ec92b80d2b99b1f76fef1efff1f787 Mon Sep 17 00:00:00 2001
From: Logan Williams <logan@bellingcat.com>
Date: Tue, 13 Jun 2023 14:04:47 +0200
Subject: [PATCH] Create README.md

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e68a632
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# osm-search
+
+This is a tool for allowing user friendly proximity queries from OpenStreetMap data.
+
+Bellingcat has a hosted version of the tool at https://osm-search.bellingcat.com/. For more information, see the accompanying article: https://osm-search.bellingcat.com/
+
+![A screenshot of the tool in use](https://www.bellingcat.com/app/uploads/2023/04/image5-3-1200x829.png)
+
+## Setup and hosting your own
+
+### Setting up the database
+
+A Postgres database must be set up with OSM data. This can be done with `osm2pgsql`. 
+
+`osm2pgsql -d osm --hstore-all planet-latest.osm.pbf`
+
+Next, some additional setup should be done on the database for performance and to create a combined view of all the data:
+
+```
+psql -d osm clean.sql
+psql -d osm cluster.sql
+psql -d osm index.sql
+psql -d osm analyze.sql
+psql -d osm views.sql
+```
+
+Note that if you run this using the entire planet OSM file, it will require about 700GB of space.
+
+### Running the API
+
+The API requires environment variables for connection with Postgres.
+
+- `PG_DB`
+- `PG_HOST`
+- `PG_PORT`
+- `PG_USER`
+- `PG_PASSWORD`
+
+### Running the frontend
+
+The frontend requires one environment variable, `VUE_ENV_MAPBOX_KEY` to be set. This Mapbox key is used for geocoding queries.