updated Readme

Author: alvaromb

README.md

@@ -1,45 +1,72 @@
-
 # react-native-interactive-image-library
 
+<p>
+<img src="https://img.shields.io/npm/dm/react-native-interactive-image-library.svg" />
+<img src="https://img.shields.io/npm/dt/react-native-interactive-image-library.svg" />
+</p>
+
+A React Native component to display a gallery of images.
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/wiki/InterfaceKit/react-native-interactive-image-library/ios.gif" alt="iOS" width="400">
+<img src="https://raw.githubusercontent.com/wiki/InterfaceKit/react-native-interactive-image-library/android.gif" alt="Android" width="400">
+</p>
+
 ## Getting started
 
-`$ npm install react-native-interactive-image-library --save`
+`$ yarn add react-native-interactive-image-library`
 
 ### Mostly automatic installation
 
 `$ react-native link react-native-interactive-image-library`
 
 ### Manual installation
 
-
 #### iOS
 
-1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
-2. Go to `node_modules` ➜ `react-native-interactive-image-library` and add `RNIKInteractiveImageLibrary.xcodeproj`
-3. In XCode, in the project navigator, select your project. Add `libRNIKInteractiveImageLibrary.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
+1. In Xcode, in the project navigator, right click `Libraries` ➜ `Add Files to
+   [your project's name]`
+2. Go to `node_modules` ➜ `react-native-interactive-image-library` and add
+   `RNIKInteractiveImageLibrary.xcodeproj`
+3. In XCode, in the project navigator, select your project. Add
+   `libRNIKInteractiveImageLibrary.a` to your project's `Build Phases` ➜ `Link
+   Binary With Libraries`
 4. Run your project (`Cmd+R`)<
 
 #### Android
 
-1. Open up `android/app/src/main/java/[...]/MainActivity.java`
-  - Add `import com.apsl.interfacekit.RNIKInteractiveImageLibraryPackage;` to the imports at the top of the file
-  - Add `new RNIKInteractiveImageLibraryPackage()` to the list returned by the `getPackages()` method
-2. Append the following lines to `android/settings.gradle`:
-  	```
-  	include ':react-native-interactive-image-library'
-  	project(':react-native-interactive-image-library').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-interactive-image-library/android')
-  	```
-3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
-  	```
-      compile project(':react-native-interactive-image-library')
-  	```
-
+No additional setup needed.
 
 ## Usage
+
 ```javascript
-import RNIKInteractiveImageLibrary from 'react-native-interactive-image-library';
+import ImageBrowser from 'react-native-interactive-image-gallery';
 
-// TODO: What to do with the module?
-RNIKInteractiveImageLibrary;
+class Images extends React.PureComponent<Props> {
+  render() {
+    const imageURLs: Array<Object> = this.props.images.map(
+      (img: Object, index: number) => ({
+        URI: img.uri,
+        id: String(index),
+        title: img.title,
+        description: img.description
+      })
+    );
+    return <ImageBrowser images={imageURLs} />;
+  }
+}
 ```
-  
+
+## API
+
+Work in progress.
+
+## License
+
+MIT.
+
+## Author
+
+Álvaro Medina Ballester `<amedina at apsl.net>`
+
+Built with 💛 by [APSL](https://github.com/apsl).