From 9d073da12e30243d884b31fe2c0df31714742d71 Mon Sep 17 00:00:00 2001 From: androiddrew Date: Tue, 7 Nov 2017 13:37:14 -0500 Subject: [PATCH] updated README.md with usage info --- README.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a7b5518..6f72e8a 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,33 @@ An API Star template for [cookiecutter](https://github.com/audreyr/cookiecutter) ## Usage - ```python - $ pip install cookiecutter - $ cookiecutter https://git.androiddrew.com/androiddrew/cookiecutter-apistar.git - ``` +```python +$ pip install cookiecutter +$ cookiecutter https://git.androiddrew.com/androiddrew/cookiecutter-apistar.git +``` You will be asked for some basic information regarding your project (name, project name, etc.). This info will be used in your new project +#### Create virtual env +``` +$ cd +$ python -m venv env +$ source env/bin/activate +$ pip install -r requirements + +#### Run tests +``` +$ pytest -v +``` +OR +``` +$ python wsgi_app.py test +``` + +#### Run dev server +``` +$ python wsgi_app.py run +``` + ## License MIT Licensed.