diff --git a/README.md b/README.md index 6b299e64c13dd10a09ae81795c9cbc2c94ce63cf..31af12ae06cf099e3f1884b77d11c48d198c9fba 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ # API Authentication Example App +This is a small Pyramid example app that demonstrates how API authentication +might be done. + +**NOTE**: The user database is maintained in memory which means every time the + server restarts the database will be reset. + ## Getting Started I highly recommend using either [Conda](http://conda.pydata.org/miniconda.html)