Merge branch 'readme-docs' of https://github.com/zencoder/zencoder-py into readme-docs

Alex Schworer · Alex Schworer · commit 2d21b573c83e · 2013-06-05T18:13:52.000-07:00
Conflicts:
	README.md
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
+
 Zencoder
-----
+--------
 
 [![Build Status](https://travis-ci.org/zencoder/zencoder-py.png?branch=master)](https://travis-ci.org/zencoder/zencoder-py)
 
@@ -16,6 +17,55 @@ Import zencoder
 ```python
 from zencoder import Zencoder
 ```
+=======
+### Create an instance of `Zencoder`
+
+    from zencoder import Zencoder
+    zen = Zencoder('abc123') # enter your api key
+
+### Submit a job
+
+    # creates an encoding job with the defaults
+    job = zen.job.create('http://input-file/movie.avi')
+    print job.code
+    print job.body
+    print job.body['id']
+
+### Return output progress
+
+    # get the transcode progress of the first output
+    progress = zen.output.progress(job.body['outputs'][0]['id'])
+    print progress.body
+
+### Create a new job with multiple outputs
+
+    # configure your outputs with dictionaries
+    iphone = {
+                 'label': 'iPhone',
+                 'url': 's3://output-bucket/output-file-1.mp4',
+                 'width': 480,
+                 'height': 320
+             }
+    web = {
+              'label': 'web',
+              'url': 's3://output-bucket/output-file.vp8',
+              'video_codec':, 'vp8'
+          }
+
+    # the outputs kwarg requires an iterable
+    outputs = (iphone, web)
+    another_job = zen.job.create(input_url, outputs=outputs)
+
+### ZENCODER_API_KEY Environment Variable
+
+```python
+import os
+os.environ['ZENCODER_API_KEY'] = 'abcd1234'
+zen = Zencoder()
+```
+
+If you set `ZENCODER_API_KEY` to your API Key, you don't have to provide it when initializing Zencoder.
+>>>>>>> a1728bd03ce089174715cf2e83ea6ead7e13a405
 
 Create an instance of the Zencoder client. This will accept an API key and version. If not API key is set, it will look for a `ZENCODER_API_KEY` environment variable. API version defaults to 'v2'.
 
