update README

This commit is contained in:
Tao Bojlen 2018-08-27 13:15:17 +02:00
parent 414578a760
commit d5879518bf

View file

@ -1,8 +1,8 @@
# fediverse-space-backend
The Django backend for fediverse.space. Scrapes the fediverse and exposes an API to get data about it.
# fediverse.space
fediverse.space is a tool to explore instances in the fediverse.
## Running it
* `cp config.json.template config.json` and enter your configuration details.
* Set the environment variable `FEDIVERSE_CONFIG` to point to the path of this file.
* For development, run `python manage.py runserver --settings=backend.settings.dev`
* In production, set the environment variable `DJANGO_SETTINGS_MODULE=backend.settings.production`
* In production, set the environment variable `DJANGO_SETTINGS_MODULE=backend.settings.production`