Skip to content

Commit

Permalink
Merge pull request #57 from samueldg/fix/misc-docs
Browse files Browse the repository at this point in the history
Various documentation fixes and improvements
  • Loading branch information
nichochar authored Apr 16, 2017
2 parents 9a404d1 + 57a40a0 commit 431ab3b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Credits
It is currently maintained by Nicholas Charriere and Yongwen Xu from Pinterest.

Thanks a lot for the contributions of:

* Owen Coutts
* Ryan Park
* Yongwen Xu
Expand Down
11 changes: 7 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,13 @@ Configuration
You can configure the following via environment variables.

`SECRET_KEY` this should be a unique key that's used to sign key. This should
be kept secret. See the `Flask Documentation`_ for more information.
be kept secret. See the `Flask Documentation`__ for more information.

`DEBUG` to run Flask web werver in debug mode. See the `Flask Documentation`_ for more information.
.. __: http://flask.pocoo.org/docs/quickstart/#sessions

.. _Flask Documentation: http://flask.pocoo.org/docs/quickstart/#sessions
`DEBUG` to run Flask web server in debug mode. See the `Flask Documentation`__ for more information.

.. __: http://flask.pocoo.org/docs/quickstart/#debug-mode

`STATIC_URL` this should be the location of your static assets. You might not
need to change this.
Expand All @@ -77,8 +79,9 @@ Alternatively, you can use `Docker`_ and `Docker Compose`_ to install and run Sn

.. _Docker: https://www.docker.com/
.. _Docker Compose: https://docs.docker.com/compose/

::

$ docker-compose up -d

This will pull all dependencies, i.e. Redis and appropriate Python version (3.6), then start up snappass and Redis server. SnapPass server is accessible at: http://localhost:5000
This will pull all dependencies, i.e. Redis and appropriate Python version (3.6), then start up SnapPass and Redis server. SnapPass server is accessible at: http://localhost:5000

0 comments on commit 431ab3b

Please sign in to comment.