From 12e86df322e5fbb210e7b4dfeb7acf6bf439a993 Mon Sep 17 00:00:00 2001 From: Brian Quinlan Date: Sat, 25 Apr 2020 16:26:16 -0700 Subject: [PATCH] Minor grammar fixes. --- server-example/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/server-example/README.md b/server-example/README.md index 6ec7b4c..d8dc3db 100644 --- a/server-example/README.md +++ b/server-example/README.md @@ -1,8 +1,10 @@ -## Simple Server +## Simple Flask Server + +This is a simple example of how badges can be served from a web server. ### Installing -Before running, it is **recommended** to install the versions of packages that were used when writing this code: +Before running the server, you must install Flask and pybadges. You can install both with: ```sh pip install -r requirements.txt @@ -10,11 +12,11 @@ pip install -r requirements.txt ### Running -You must set the FLASK_APP environment variable before running the server: +To run the server, you must set the FLASK_APP environment variable before running the server using Flask: ```sh export FLASK_APP=app.py flask run ``` - * Running on http://127.0.0.1:5000/ \ No newline at end of file +After this step, you can view your badge on http://127.0.0.1:5000/