From 02c5ada16fd6e3f00b8745e0c6865dcf78e827a2 Mon Sep 17 00:00:00 2001 From: Piero Toffanin Date: Wed, 1 Mar 2017 18:45:36 -0500 Subject: [PATCH] Updated readme --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7b79112c..736bdab0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://travis-ci.org/OpenDroneMap/WebODM.svg?branch=master)](https://travis-ci.org/OpenDroneMap/WebODM) -A free, user-friendly, extendable application and API for drone image processing. Generate georeferenced maps, point clouds and textured 3D models from aerial images. It uses [OpenDroneMap](https://github.com/OpenDroneMap/OpenDroneMap) for processing. +A free, user-friendly, extendable application and [API](#api-docs) for drone image processing. Generate georeferenced maps, point clouds and textured 3D models from aerial images. It uses [OpenDroneMap](https://github.com/OpenDroneMap/OpenDroneMap) for processing. ![Alt text](/screenshots/ui-mockup.png?raw=true "WebODM") @@ -80,6 +80,10 @@ WebODM can be linked to one or more processing nodes running [node-OpenDroneMap] If you want to run WebODM in production, make sure to change the `SECRET_KEY` variable in `webodm/settings.py`, as well as any other relevant setting as indicated in the [Django Deployment Checklist](https://docs.djangoproject.com/en/1.10/howto/deployment/checklist/). +## API Docs + +See the [API documentation page](https://opendronemap.github.io/WebODM/#introduction). + ## Run it natively If you want to run WebODM natively, you will need to install: @@ -174,7 +178,7 @@ Should all work without errors. - [X] Cluster management and setup. - [ ] Mission Planner - [X] API -- [ ] Documentation +- [X] Documentation - [ ] Android Mobile App - [ ] iOS Mobile App - [ ] Processing Nodes Volunteer Network