Commit d9652325 authored by Johannes Visintini's avatar Johannes Visintini
Browse files

Merge branch 'extend-readme' into 'oshdb-snapshot'

extend README with information on the new default branches

See merge request !12
parents baa13dca 66d86ce5
Pipeline #1482 created
# OSHDB Examples
These are some examples for the use of the OSHDB. This repository focusses on the [OSHDB-API](https://github.com/GIScience/oshdb/blob/master/documentation/oshdb-api-tutorial/README.md).
These are some examples for the use of the OSHDB. This repository focuses on the [OSHDB-API](https://github.com/GIScience/oshdb/blob/master/documentation/oshdb-api-tutorial/README.md).
You can checkout this repository an run the classes to see imediate results and try coding yourself.
You can check out this repository and run the example classes to see immediate results or use it as building blocks for coding your own OSHDB queries.
# Tutorial
The [Tutorial](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/tree/master/src/main/java/org/heigit/ohsome/oshdb/tutorial) is a quick and simple dive into the OSHDB-API-Code.
## Main Branches
# Analyses
| branch name | description |
| ----------- | ----------- |
| [`oshdb-snapshot`](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/-/tree/oshdb-snapshot) (default) | use if you want to work with the [current development state](https://github.com/giscience/oshdb/tree/master) of the OSHDB |
| [`oshdb-stable`](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/-/tree/oshdb-stable) | use if you want to work with the [latest release](https://github.com/GIScience/oshdb/releases/latest) of the OSHDB |
Some example analyses used in research are demonstrated in th [analyses](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/tree/master/src/main/java/org/heigit/ohsome/oshdb/examples/analyses) package.
## Tutorial
The [tutorial](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/tree/master/src/main/java/org/heigit/ohsome/oshdb/tutorial) is a quick and simple dive into the OSHDB-API-Code.
## Analyses
Some example analyses used in research are demonstrated in the [analyses](https://gitlab.gistools.geog.uni-heidelberg.de/giscience/big-data/ohsome/oshdb-examples/tree/master/src/main/java/org/heigit/ohsome/oshdb/examples/analyses) package.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment