Initial

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c52dd76
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# OpenStreetMaps to Mongo
+
+Simple loader from osm dump file to mongodb. Based on https://github.com/paulmach/osm package.
+
+## Build
+
+`go build -o osm2go`
+
+## Usage
+
+`./osm2go -osmfile PATH_TO_OSM_FILE [-dbconnection mongodb://localhost:27017] [-dbname osm]`
+
+* `osmfile` required, path to *.osm or *.osm.pbf file
+* `dbconnection` optional, mongodb connection string (default: `mongodb://localhost:27017`) 
+* `dbname` optional, mongodb database name (default: `osm`) 
+
+## Example
+
+```
+# ./osm2mgo -osmfile ~/Downloads/RU.pbf
+Nodes: 1294069 Ways: 0 Relations: 0
+```
\ No newline at end of file