Skip to content

Commit a1a611c

Browse files
author
Sam Harrison
committed
Use a consistent template for reference documentation links
1 parent a20fb1b commit a1a611c

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# twilio-python
22

3-
[![Build Status](https://secure.travis-ci.org/twilio/twilio-python.png?branch=master)](http://travis-ci.org/twilio/twilio-python)
3+
[![Build Status](https://secure.travis-ci.org/twilio/twilio-python.png?branch=master)](https://travis-ci.org/twilio/twilio-python)
44
[![PyPI](https://img.shields.io/pypi/v/twilio.svg)](https://pypi.python.org/pypi/twilio)
55
[![PyPI](https://img.shields.io/pypi/pyversions/twilio.svg)](https://pypi.python.org/pypi/twilio)
66

7-
A module for using the Twilio REST API and generating valid
8-
[TwiML](http://www.twilio.com/docs/api/twiml/ "TwiML -
9-
Twilio Markup Language").
7+
## Documentation
8+
9+
The documentation for the Twilio API can be found [here][apidocs].
10+
11+
The Python library documentation can be found [here][libdocs].
1012

1113
## Recent Update
1214

@@ -44,6 +46,7 @@ source code") for `twilio-python`, and then run:
4446
You may need to run the above commands with `sudo`.
4547

4648
### Migrate from 5.x
49+
4750
Please consult the [official migration guide](https://www.twilio.com/docs/libraries/python/migration-guide) for information on upgrading your application using twilio-python 5.x to 6.x
4851

4952
## Getting Started
@@ -106,11 +109,11 @@ message = client.messages.create(to="+12316851234", from_="+15555555555",
106109
body="Hello there!")
107110
```
108111

109-
### Handling a call using TwiML
112+
### Generating TwiML
110113

111-
To control phone calls, your application needs to output
112-
[TwiML](http://www.twilio.com/docs/api/twiml/ "TwiML - Twilio Markup
113-
Language"). Use `twilio.twiml.Response` to easily create such responses.
114+
To control phone calls, your application needs to output [TwiML][twiml].
115+
116+
Use `twilio.twiml.Response` to easily create such responses.
114117

115118
```python
116119
from twilio.twiml.voice_response import VoiceResponse
@@ -134,3 +137,7 @@ The `Dockerfile` present in this repository and its respective `twilio/twilio-py
134137
If you need help installing or using the library, please check the [Twilio Support Help Center](https://support.twilio.com) first, and [file a support ticket](https://twilio.com/help/contact) if you don't find an answer to your question.
135138

136139
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
140+
141+
[apidocs]: https://www.twilio.com/docs/api
142+
[twiml]: https://www.twilio.com/docs/api/twiml
143+
[libdocs]: https://twilio.github.io/twilio-python

0 commit comments

Comments
 (0)