docs: update readme

Author: JimmyDaddy

README.md

@@ -1,6 +1,6 @@
 # react-native-bs-diff-patch
 
-rn bs diff patch 
+rn bs diff patch file
 
 ## Installation
 
@@ -11,11 +11,17 @@ npm install react-native-bs-diff-patch
 ## Usage
 
 ```js
-import { multiply } from 'react-native-bs-diff-patch';
+import { diff, patch } from 'react-native-bs-diff-patch';
 
 // ...
 
-const result = await multiply(3, 7);
+/**
+ * generate patch file from old file and new file
+ */
+await diff(oldFile, newFile, patchFile);
+// generate new file from old file and patch file
+await patch(oldFile, newFile, patchFile);
+
 ```
 
 ## Contributing

src/index.ts

@@ -17,6 +17,12 @@ const BsDiffPatch = NativeModules.BsDiffPatch
       }
     );
 
+/**
+ * generate new file from old file and patch file
+ * @param oldFile orignal file path
+ * @param newFile new file path
+ * @param patchFile patch file path
+ **/
 export function patch(
   oldFile: string,
   newFile: string,
@@ -25,6 +31,13 @@ export function patch(
   return BsDiffPatch.patch(oldFile, newFile, patchFile);
 }
 
+/**
+ * generate patch file from old file and new file
+ * @param oldFile orignal file path
+ * @param newFile new file path
+ * @param patchFile patch file path
+ * @returns
+ */
 export function diff(
   oldFile: string,
   newFile: string,