Skip to content

Commit

Permalink
Update readme with docs and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
makmanalp committed Dec 1, 2015
1 parent d7dbc23 commit 55840f4
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Subnational Atlas
=================
Subnational API
===============

The API backend for subnational atlas projects at Harvard CID. It's written in
python and flask.

[![Doc build status](https://readthedocs.org/projects/atlas-subnational-api/badge/?version=latest)](http://atlas-subnational-api.readthedocs.org/en/latest/)

Documentation
-------------

For more information on how to access the API and other details, check the
[documentation](http://atlas-subnational-api.readthedocs.org/en/latest/).

Usage
-----
Expand Down Expand Up @@ -29,8 +39,3 @@ The `/conf/` directory contains configuration files. `dev.py` is included by
default. You pass the `CHASSIS_CONFIG="path/to/config.py"` environment variable
to pick a settings file. It's this way to make sure no one accidentally loads
the dev config in production.

Changelog
---------

* Nothing here yet until release.

0 comments on commit 55840f4

Please sign in to comment.