From 12959cd720471c4a80596ec42017742ca2b7cd64 Mon Sep 17 00:00:00 2001
From: Kyle Fang <zhigang1992@gmail.com>
Date: Tue, 3 Dec 2019 12:00:16 +0800
Subject: [PATCH] prepare for release

---
 README.md      | 19 ++++++++++++++-----
 example/App.js |  4 ++--
 index.d.ts     |  1 +
 index.js       |  2 +-
 package.json   | 10 ++++------
 5 files changed, 22 insertions(+), 14 deletions(-)
 create mode 100644 index.d.ts

diff --git a/README.md b/README.md
index 2f46da8..ca5d907 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,16 @@
 # react-native-video-cache
 
+Boost performance on online video loading and caching
+
+Use following libraries to do the heavy lifting.
+
+- iOS: https://github.com/ChangbaDevs/KTVHTTPCache
+- Android: https://github.com/danikula/AndroidVideoCache
+
+
 ## Getting started
 
-`$ npm install react-native-video-cache --save`
+`$ yarn add react-native-video-cache`
 
 ### Mostly automatic installation
 
@@ -10,8 +18,9 @@
 
 ## Usage
 ```javascript
-import VideoCache from 'react-native-video-cache';
-
-// TODO: What to do with the module?
-VideoCache;
+import convertToProxyURL from 'react-native-video-cache';
+...
+const localProxiedURL = await convertToProxyURL(originalURL);
+...
+<Video source={{uri: localProxiedURL}} />
 ```
diff --git a/example/App.js b/example/App.js
index ff960e0..6bf51bf 100644
--- a/example/App.js
+++ b/example/App.js
@@ -10,7 +10,7 @@
 
 import React, { Component } from 'react';
 import { Platform, StyleSheet, Text, View } from 'react-native';
-import VideoCache from 'react-native-video-cache';
+import convertToCache from 'react-native-video-cache';
 
 export default class App extends Component<{}> {
   state = {
@@ -18,7 +18,7 @@ export default class App extends Component<{}> {
     message: '--'
   };
   componentDidMount() {
-    VideoCache.convert('https://cdn.plyr.io/static/demo/View_From_A_Blue_Moon_Trailer-720p.mp4').then((message) => {
+    convertToCache('https://cdn.plyr.io/static/demo/View_From_A_Blue_Moon_Trailer-720p.mp4').then((message) => {
       this.setState({
         status: 'native callback received',
         message
diff --git a/index.d.ts b/index.d.ts
new file mode 100644
index 0000000..adfe0de
--- /dev/null
+++ b/index.d.ts
@@ -0,0 +1 @@
+export default function convert(url: string): Promise<string>
diff --git a/index.js b/index.js
index b2772a7..d97b62d 100644
--- a/index.js
+++ b/index.js
@@ -2,4 +2,4 @@ import { NativeModules } from 'react-native';
 
 const { VideoCache } = NativeModules;
 
-export default VideoCache;
+export default VideoCache.convert;
diff --git a/package.json b/package.json
index ebcd743..4f06e34 100644
--- a/package.json
+++ b/package.json
@@ -2,11 +2,9 @@
   "name": "react-native-video-cache",
   "title": "React Native Video Cache",
   "version": "1.0.0",
-  "description": "TODO",
+  "description": "Boost performance on online video loading and caching",
   "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
+  "types": "index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zhigang1992/react-native-video-cache.git",
@@ -23,8 +21,8 @@
   "licenseFilename": "LICENSE",
   "readmeFilename": "README.md",
   "peerDependencies": {
-    "react": "^16.8.1",
-    "react-native": ">=0.59.0-rc.0 <1.0.x"
+    "react": "*",
+    "react-native": "*"
   },
   "devDependencies": {
     "react": "^16.8.3",