Added gallery screenshot and improved README.md

[video-tweet.git] / README.md

diff --git a/README.md b/README.md
index 7bae6154b84ac38e225e82780d2d3e7ecd7c2317..643537a6f2bf66d84831ab3c8317fbd64fccd06c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,26 @@
 # Large Video Upload
 
-This python sample demonstrates the following process of uploading large video files asynchronously with the Twitter API. 
+This Python sample demonstrates the following process of uploading large video files asynchronously with the Twitter API.
 
 1. **INIT** media upload.
 2. **APPEND** chunked data.
 3. **FINALIZE** media uploaded.
 4. Check **STATUS** of video processing.
-5. Tweeting with attached video.
-
-Large video files are longer than 30 second up to 140 seconds and/or a file size larger than 15 megabytes up to 512 megabytes.
+5. Tweet with attached video.
 
+Large video files are longer than 30 seconds up to 140 seconds, and/or a file size larger than 15 megabytes up to 512 megabytes.
 
+[Learn more](https://dev.twitter.com/rest/media) about the Twitter Media APIs. Pay attention to the other requirements such as encoding, frame size and video formats supported.
 
 ## Running the sample
 
 1. Install requirements:
 
        ```
-       $ pip install requirements.txt
+       $ pip install -r requirements.txt
        ```
 
-2. Fill in your consumer keys and access tokens in `async-upload.py`:
+2. Fill in your [consumer keys and access tokens](https://apps.twitter.com) in `async-upload.py`:
 
        ```
        CONSUMER_KEY = 'your-consumer-key'
@@ -29,8 +29,16 @@ Large video files are longer than 30 second up to 140 seconds and/or a file size
        ACCESS_TOKEN_SECRET = 'your-access-secret'
        ```
 
-3. Run script:
+3. Edit path to your video file in `async-upload.py`:
+
+ ```
+ VIDEO_FILENAME = 'path/to/video/file'
+ ```
+
+4. Run script:
 
        ```
        $ python async-upload.py
-       ```
\ No newline at end of file
+       ```
+
+Questions? Check our [developer discussion forums](https://https://twittercommunity.com/c/media-apis).