From 1c92ba7a1b71ad0d289f61446c257253f5fff57b Mon Sep 17 00:00:00 2001
From: Steven Loria <sloria1@gmail.com>
Date: Fri, 6 Dec 2013 19:00:56 -0600
Subject: [PATCH] update READMEs
---
README.rst | 6 ++++--
{{cookiecutter.repo_name}}/README.rst | 18 ++----------------
2 files changed, 6 insertions(+), 18 deletions(-)
diff --git a/README.rst b/README.rst
index 90f5e4e9..d250497f 100644
--- a/README.rst
+++ b/README.rst
@@ -11,11 +11,11 @@ Features
- Twitter Bootstrap 3 and starter templates
- Flask-SQLAlchemy with basic User model
- Flask-WTForms with login and registration forms
+- Flask-Login for authentication
- Procfile for deploying to a PaaS (e.g. Heroku)
- Flask-Testing and nose for testing
- A simple ``manage.py`` script.
- CSS and JS minification using Flask-Assets
-- Easily switch between development and production environments through the MYFLASKAPP_ENV system variable.
- Utilizes best practices: `Blueprints <http://flask.pocoo.org/docs/blueprints/>`_ and `Application Factory <http://flask.pocoo.org/docs/patterns/appfactories/>`_ patterns
Screenshots
@@ -50,6 +50,7 @@ Inspiration
- `Getting Bigger with Flask <http://maximebf.com/blog/2012/11/getting-bigger-with-flask/>`_
- `Structuring Flask Apps <http://charlesleifer.com/blog/structuring-flask-apps-a-how-to-for-those-coming-from-django/>`_
- `Flask-Foundation <https://github.com/JackStouffer/Flask-Foundation>`_ by `@JackStouffer <https://github.com/JackStouffer>`_
+- `flask-bones <https://github.com/cburmeister/flask-bones>`_ by `@cburmeister <https://github.com/cburmeister>`_
- `flask-basic-registration <https://github.com/mjhea0/flask-basic-registration>`_ by `@mjhea0 <https://github.com/mjhea0>`_
- `Flask Official Documentation <http://flask.pocoo.org/docs/>`_
@@ -64,9 +65,10 @@ Changelog
0.3.0
*****
-- More "divisional" organization: each blueprint contains its own view, models, and forms in a directory. There is still a single directory for templates and static assets.
+- "Divisional" organization: each blueprint contains its own view, models, and forms in a directory. There is still a single directory for templates and static assets.
- Use Flask-Bcrypt for password hashing.
- Flask-Testing support.
+- Flask-Login for authentication.
0.2.0 (09/21/2013)
******************
diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst
index 098e00a8..db9fb5dd 100644
--- a/{{cookiecutter.repo_name}}/README.rst
+++ b/{{cookiecutter.repo_name}}/README.rst
@@ -13,9 +13,8 @@ Quickstart
git clone https://github.com/{{cookiecutter.github_username}}/{{ cookiecutter.repo_name }}
cd {{cookiecutter.repo_name}}
pip install -r requirements/dev.txt
- export {{cookiecutter.repo_name|upper}}_ENV='dev'
python manage.py createdb
- python manage.py runserver
+ python manage.py server
Shell
@@ -25,17 +24,4 @@ To open the interactive shell, run ::
python manage.py shell
-By default, you will have access to ``app``, ``models``, and ``db``.
-
-Development / Production Environments
--------------------------------------
-
-Configuration environements are handled through the {{cookiecutter.repo_name|upper}}_ENV system environment variable.
-
-To switch to the development environment, set ::
-
- export {{cookiecutter.repo_name|upper}}_ENV="dev"
-
-To switch to the production environment, set ::
-
- export {{cookiecutter.repo_name|upper}}_ENV="prod"
+By default, you will have access to ``app`` and ``db``.
--
GitLab