diff --git a/README.md b/README.md index f1b2c55..4ba6438 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # GaiaAPIClient -Python module, the client part to the GaiaDBInterface Django app. \ No newline at end of file +Python module, the client part to the GaiaDBInterface Django app. + +## Description + +Implements cone search in conjuction with GaiaDBInterface. Server's IP is hardcoded, accepts inputs for ra, dec and search radius in decimal degrees, as well as the healpix order ('ring' or 'nested'). + +## Installation + +Install with pip: +`pip install git+http://heagit.cosmos.ru/tyrin/GaiaAPIClient.git` +Requires your git credentials. \ No newline at end of file