Updated README

Author: hiteshsondhi88

FFmpegAndroid/src/main/java/github/hiteshsondhi88/libffmpeg/FFmpeg.java

@@ -3,9 +3,7 @@
 import android.content.Context;
 import android.text.TextUtils;
 
-import org.apache.http.NameValuePair;
-
-import java.util.List;
+import java.util.Map;
 
 import github.hiteshsondhi88.libffmpeg.exceptions.FFmpegCommandAlreadyRunningException;
 import github.hiteshsondhi88.libffmpeg.exceptions.FFmpegNotSupportedException;
@@ -63,7 +61,7 @@ public void loadBinary(FFmpegLoadBinaryResponseHandler ffmpegLoadBinaryResponseH
     }
 
     @Override
-    public void execute(List<NameValuePair> environvenmentVars, String cmd, FFmpegExecuteResponseHandler ffmpegExecuteResponseHandler) throws FFmpegCommandAlreadyRunningException {
+    public void execute(Map<String, String> environvenmentVars, String cmd, FFmpegExecuteResponseHandler ffmpegExecuteResponseHandler) throws FFmpegCommandAlreadyRunningException {
         if (ffmpegExecuteAsyncTask != null && !ffmpegExecuteAsyncTask.isProcessCompleted()) {
             throw new FFmpegCommandAlreadyRunningException("FFmpeg command is already running, you are only allowed to run single command at a time");
         }

FFmpegAndroid/src/main/java/github/hiteshsondhi88/libffmpeg/FFmpegInterface.java

@@ -1,8 +1,6 @@
 package github.hiteshsondhi88.libffmpeg;
 
-import org.apache.http.NameValuePair;
-
-import java.util.List;
+import java.util.Map;
 
 import github.hiteshsondhi88.libffmpeg.exceptions.FFmpegCommandAlreadyRunningException;
 import github.hiteshsondhi88.libffmpeg.exceptions.FFmpegNotSupportedException;
@@ -24,7 +22,7 @@ interface FFmpegInterface {
      * @param ffmpegExecuteResponseHandler {@link github.hiteshsondhi88.libffmpeg.FFmpegExecuteResponseHandler}
      * @throws FFmpegCommandAlreadyRunningException
      */
-    public void execute(List<NameValuePair> environvenmentVars, String cmd, FFmpegExecuteResponseHandler ffmpegExecuteResponseHandler) throws FFmpegCommandAlreadyRunningException;
+    public void execute(Map<String, String> environvenmentVars, String cmd, FFmpegExecuteResponseHandler ffmpegExecuteResponseHandler) throws FFmpegCommandAlreadyRunningException;
 
     /**
      * Executes a command

FFmpegAndroid/src/main/java/github/hiteshsondhi88/libffmpeg/FileUtils.java

@@ -3,13 +3,11 @@
 import android.content.Context;
 import android.util.Log;
 
-import org.apache.http.NameValuePair;
-
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.List;
+import java.util.Map;
 
 class FileUtils {
 
@@ -55,11 +53,11 @@ static String getFFmpeg(Context context) {
         return getFilesDirectory(context).getAbsolutePath() + File.separator + FileUtils.ffmpegFileName;
     }
 
-    static String getFFmpeg(Context context, List<NameValuePair> environmentVars) {
+    static String getFFmpeg(Context context, Map<String,String> environmentVars) {
         String ffmpegCommand = "";
         if (environmentVars != null) {
-            for (NameValuePair var : environmentVars) {
-                ffmpegCommand += var.getName()+"="+var.getValue()+" ";
+            for (Map.Entry<String, String> var : environmentVars.entrySet()) {
+                ffmpegCommand += var.getKey()+"="+var.getValue()+" ";
             }
         }
         ffmpegCommand += getFFmpeg(context);

README.md

@@ -10,9 +10,59 @@ Supported Architecture
 * armv7-neon
 * x86
 
-Instructions
-----
-* TODO
+## Usage
+
+### Load Binary
+
+```java
+FFmpeg ffmpeg = FFmpeg.getInstance(context);
+try {
+  ffmpeg.loadBinary(new FFmpegLoadBinaryResponseHandler() {
+
+    @Override
+    public void onStart() {}
+
+    @Override
+    public void onFailure() {}
+
+    @Override
+    public void onSuccess() {}
+
+    @Override
+    public void onFinish() {}
+  });
+} catch (FFmpegNotSupportedException e) {
+  // Handle if FFmpeg is not supported by device
+}
+```
+
+### Execute Binary
+
+```java
+FFmpeg ffmpeg = FFmpeg.getInstance(context);
+try {
+  // to execute "ffmpeg -version" command you just need to pass "-version"
+  ffmpeg.execute(cmd, new FFmpegExecuteResponseHandler() {
+
+    @Override
+    public void onStart() {}
+
+    @Override
+    public void onProgress(String message) {}
+
+    @Override
+    public void onFailure(String message) {}
+
+    @Override
+    public void onSuccess(String message) {}
+
+    @Override
+    public void onFinish() {}
+  });
+} catch (FFmpegCommandAlreadyRunningException e) {
+  // Handle if FFmpeg is already running
+}
+```
 
 License
 ----