add README.rst

tzangms · tzangms · commit af8b09a5ee21 · 2014-04-10T15:37:21.000+08:00
diff --git a/README.rst b/README.rst
@@ -0,0 +1,77 @@
+django-elastic-transcoder
+=========================
+
+|Build Status| |Coverage Status|
+
+Django + AWS Elastic Transcoder
+
+Install
+-------
+
+First, install ``dj_elastictranscode`` with ``pip``
+
+.. code:: sh
+
+    $ pip install django-elastic-transcoder
+
+Then, add ``dj_elastictranscoder`` to ``INSTALLED_APPS``
+
+.. code:: python
+
+    INSTALLED_APPS = (
+        ...
+        'dj_elastictranscoder',
+        ...
+    )
+
+Bind ``urls.py``
+
+.. code:: python
+
+    urlpatterns = patterns('',
+        ...
+        url(r'^dj_elastictranscoder/', include('dj_elastictranscoder.urls')),
+        ...
+    )
+
+Migrate
+
+.. code:: sh
+
+    $ ./manage.py migrate
+
+Setting up AWS Elastic Transcoder
+---------------------------------
+
+1. Create a new ``Pipeline`` in AWS Elastic Transcoder.
+2. Hookup every Notification.
+3. Subscribe SNS Notification through HTTP
+4. You are ready to encode!
+
+Usage
+-----
+
+For instance, encode an mp3
+
+.. code:: python
+
+    from dj_elastictranscoder.transcoder import Transcoder
+
+    input = {
+        'Key': 'path/to/input.mp3', 
+    }
+
+    outputs = [{
+        'Key': 'path/to/output.mp3',
+        'PresetId': '1351620000001-300040' # for example: 128k mp3 audio preset
+    }]
+
+    pipeline_id = '<pipeline_id>'
+
+    transcoder = Transcoder(pipeline_id, 'ap-southeast-1')
+    transcoder.encode(input, outputs)
+
+.. |Build Status| image:: https://travis-ci.org/StreetVoice/django-elastic-transcoder.png?branch=master
+   :target: https://travis-ci.org/StreetVoice/django-elastic-transcoder
+.. |Coverage Status| image:: https://coveralls.io/repos/StreetVoice/django-elastic-transcoder/badge.png?branch=master
+   :target: https://coveralls.io/r/StreetVoice/django-elastic-transcoder?branch=master
