Skip to content

Commit fa21f81

Browse files
committed
Documentation improvements
1 parent b2a23ad commit fa21f81

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ A simple Python + Flask web app that demonstrates the flow of obtaining a [Twitt
55
## Setup
66

77
1. Obtain consumer key and secret from the Twitter Developer portal. The app should be configured to enable Sign in with Twitter. See `twauth-web.py` for more details, but you can either:
8-
1. add these values to a `config.cfg` file (local); or
9-
2. set environment variables `TWAUTH_APP_CONSUMER_KEY` and `TWAUTH_APP_CONSUMER_SECRET` (cloud or local)
8+
1. add these values to a `config.cfg` file (local deployment); or
9+
2. set environment variables `TWAUTH_APP_CONSUMER_KEY` and `TWAUTH_APP_CONSUMER_SECRET` (cloud deployment)
1010
2. Setup a [pipenv](https://pipenv.readthedocs.io/en/latest/) environment, and install dependencies:
1111
1. `pipenv install`
1212
2. `pipenv shell`
1313
3. Start the app:
1414
1. `python3 ./twauth-web.py`; or
1515
2. `gunicorn twauth-web:app`
1616

17-
Note: the app must have an externally-accessible URL (i.e do not attempt to connect via localhost). You can run a tunnel e.g. `ngrok` for local use, or deploy to a cloud environment such as Heroku (a `Procfile` is included).
17+
> Note: the app must have an Internet-accessible URL - do not attempt to connect via localhost, as this will not work. You can run a tunnel e.g. `ngrok` for local use, or deploy to a cloud platform such as Heroku (a `Procfile` is included).
1818
1919
Open a browser window on your demo app's external URL. Don't click the buttons yet!
2020

21-
Finally, revisit the dev portal, and add your app's callback URL (`http[s]://your-deployed-url/callback`) to the callback URL whitelist setting, before attempting to click through the demo pages.
21+
Finally, revisit the dev portal, and add your app's callback URL (`http[s]://your-deployed-url/callback`) to the callback URL whitelist setting. Once saved, follow the instructions on the app's web UI to click through the demo pages.
2222

2323
## Reference
2424

2525
[Twitter Developer Portal](https://developer.twitter.com/)
26-
[Flask](http://flask.pocoo.org/)
26+
[Flask](https://flask.pocoo.org/)
2727
[python-oauth2](https://github.com/simplegeo/python-oauth2)
28-
[Bootstrap](http://getbootstrap.com/)
28+
[Bootstrap](https://getbootstrap.com/)
2929

3030
### Credits
3131

0 commit comments

Comments
 (0)