Merge pull request #207 from cardoso/patch-1

Tweak design and spelling in README

Author: vishalnarkhede

README.md

@@ -1,6 +1,8 @@
-# React Native Chat Components
+# Official React Native SDK for [Stream Chat](https://getstream.io/chat/)
 
-<a href="https://getstream.io/chat/react-native-chat/tutorial/"><img src="https://i.imgur.com/SRkDlFX.png" alt="react native chat" /></a>
+<p align="center">
+  <a href="https://getstream.io/chat/react-native-chat/tutorial/"><img src="https://i.imgur.com/SRkDlFX.png" alt="react native chat" width="60%" /></a>
+</p>
 
 > The official React Native and Expo components for Stream Chat, a service for
 > building chat applications.
@@ -9,6 +11,8 @@
 [![Build Status](https://travis-ci.org/GetStream/stream-chat-react-native.svg?branch=master)](https://travis-ci.org/GetStream/stream-chat-react-native)
 [![Component Reference](https://img.shields.io/badge/docs-component%20reference-blue.svg)](https://getstream.github.io/stream-chat-react-native/)
 
+<img align="right" src="https://getstream.imgix.net/images/ios-chat-tutorial/[email protected]?auto=format,enhance" width="50%" />
+
 **Quick Links**
 
 - [Stream Chat API](https://getstream.io/chat/) product overview
@@ -38,11 +42,11 @@
 
 ## React Native Chat Tutorial
 
-The best place to start is the [React Native Chat Tutorial](https://getstream.io/chat/react-native-chat/tutorial/). It teaches you how to use this SDK and also shows how to make common changes.
+The best place to start is the [React Native Chat Tutorial](https://getstream.io/chat/react-native-chat/tutorial/). It teaches you how to use this SDK and also shows how to make frequently required changes.
 
 ## Example Apps
 
-This repo includes 2 example apps. One that's used with Expo, and one for native.
+This repo includes 2 example apps. One made with Expo, and one Native.
 
 <div style="display: inline">
   <img src="./screenshots/1.png" alt="IMAGE ALT TEXT HERE" width="250" border="1" style="margin-right: 30px" />
@@ -62,7 +66,7 @@ This repo includes 2 example apps. One that's used with Expo, and one for native
 
 ### Native example
 
-1. Please make sure you have installed necessary dependencies depending on your development OS and target OS. Follow the guidelines given on official react native documentation for installing dependencies: https://facebook.github.io/react-native/docs/getting-started#
+1. Please make sure you have installed necessary dependencies depending on your development OS and target OS. Follow the guidelines given on official React Native documentation for installing dependencies: https://facebook.github.io/react-native/docs/getting-started#
 2. Make sure node version is >= v10.13.0
 3. Start the simulator
 
@@ -88,11 +92,11 @@ This repo includes 2 example apps. One that's used with Expo, and one for native
    > Keystore file '/path_to_project/stream-chat-react-native/examples/NativeMessaging/android/app/debug.keystore' not found for signing config 'debug'.
    ```
 
-   You can generate the debug keystore by running this command in the `android/app/` directory: `keytool -genkey -v -keystore debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000` - [Reference](https://github.com/facebook/react-native/issues/25629#issuecomment-511209583)
+   You can generate the debug Keystore by running this command in the `android/app/` directory: `keytool -genkey -v -keystore debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000` - [Reference](https://github.com/facebook/react-native/issues/25629#issuecomment-511209583)
 
 ### Slack clone
 
-Checkout our tutorial on how to build a slack clone using react-native and stream-chat-react-native
+Check out our tutorial on how to build a slack clone using react-native and stream-chat-react-native
 
 <div style="display: inline">
   <img src="./screenshots/4.png" alt="IMAGE ALT TEXT HERE" width="250" border="1" style="margin-right: 30px" />
@@ -111,16 +115,15 @@ Checkout our tutorial on how to build a slack clone using react-native and strea
 
 The [styleguidist docs for stream-chat-react-native](https://getstream.github.io/stream-chat-react-native/) document how all the components work.
 
-The React Native components are created using the stream-chat-js library. If you're customizing the components it's important to learn how the Chat Server API works. You'll want to review our [JS chat API docs](https://getstream.io/chat/docs/js/).
+The React Native components are created using the stream-chat-js library. If you're customizing the components, it's essential to learn how the Chat Server API works. You'll want to review our [JS chat API docs](https://getstream.io/chat/docs/js/).
 
 ## Keep in mind
 
-1. Navigation between different component is something we expect consumers to
-   implement. You can checkout the example given in this repository
+1. Navigation between different components is something we expect consumers to implement. You can check out the example given in this repository
 
-2. Minor releases may come with some breaking changes, so always check the release notes before upgrading minor version.
+2. Minor releases may come with some breaking changes, so always check the release notes before upgrading the minor version.
 
-Library currently exposes following components:
+Library currently exposes the following components:
 
 1. Avatar
 2. Chat
@@ -137,7 +140,7 @@ Library currently exposes following components:
 
 You can see detailed documentation about the components at https://getstream.github.io/stream-chat-react-native
 
-## Setup (Setting up an chat app)
+## Setup (Setting up a chat app)
 
 ### Expo package
 
@@ -153,13 +156,13 @@ cd StreamChatExpoExample
 # Add chat expo package
 yarn add stream-chat-expo
 
-# If you are using stream-chat-expo <= 0.4.0 and expo <= 34, then you don't need to add @react-native-community/netinfo as dependency. Since previously we used use NetInfo from react-native package.
+# If you are using stream-chat-expo <= 0.4.0 and expo <= 34, then you don't need to add @react-native-community/netinfo as dependency, since previously we used NetInfo from react-native package.
 expo install @react-native-community/netinfo expo-document-picker expo-image-picker expo-permissions
 ```
 
-Please check [Example](https://github.com/GetStream/stream-chat-react-native/blob/master/examples/ExpoMessaging/App.js) to see usage of the components.
+Please check the [example](https://github.com/GetStream/stream-chat-react-native/blob/master/examples/ExpoMessaging/App.js) to see usage of the components.
 
-OR you can swap [this file](https://github.com/GetStream/stream-chat-react-native/blob/master/examples/ExpoMessaging/App.js) for your `App.js` in the root folder with additional following steps:
+OR you can swap [this file](https://github.com/GetStream/stream-chat-react-native/blob/master/examples/ExpoMessaging/App.js) for your `App.js` in the root folder with by following these additional steps:
 
 ```bash
 yarn add [email protected] react-native-gesture-handler react-native-reanimated
@@ -197,9 +200,9 @@ react-native link react-native-document-picker
 
 ```
 
-Please check [Example](https://github.com/GetStream/stream-chat-react-native/blob/master/examples/NativeMessaging/App.js) to see usage of components.
+Please check the [example](https://github.com/GetStream/stream-chat-react-native/blob/master/examples/NativeMessaging/App.js) to see the usage of these components.
 
-OR you can swap this file for your `App.js` in root folder with additional following steps:
+OR you can swap this file for your `App.js` in the root folder by following these additional steps:
 
 ```bash
 yarn add [email protected]
@@ -208,7 +211,7 @@ react-native link react-native-gesture-handler
 react-native link react-native-reanimated
 ```
 
-If you are planning to use image picker, there are some additional steps to be done. You can find them here - https://github.com/react-native-community/react-native-image-picker/blob/master/docs/Install.md
+If you are planning to use the image picker, there are some additional steps to be done. You can find them here - https://github.com/react-native-community/react-native-image-picker/blob/master/docs/Install.md
 
 If you are planning to use file/document picker, you need to enable iCloud capability in your app - https://github.com/Elyx0/react-native-document-picker#reminder
 
@@ -229,23 +232,23 @@ cd ios && pod install && cd ..
 
 ```
 
-Just to be sure, please verify you are using appropriate version of following packages as per your react-native version.
+Just to be sure, please verify you are using the appropriate version of the following packages as per your react-native version.
 
 - netinfo : https://github.com/react-native-community/react-native-netinfo#react-native-compatibility
 
 - react-native-image-picker : https://github.com/react-native-community/react-native-image-picker#react-native-compatibility
 
-Please check [Example](https://github.com/GetStream/stream-chat-react-native/blob/master/examples/NativeMessaging/App.js) to see usage of components.
+Please check the [example](https://github.com/GetStream/stream-chat-react-native/blob/master/examples/NativeMessaging/App.js) to see the usage of components.
 
-OR you can swap this file for your `App.js` in root folder with additional following steps:
+OR you can swap this file for your `App.js` in the root folder by following these additional steps:
 
 ```bash
 yarn add [email protected]
 yarn add react-native-gesture-handler react-native-reanimated
 cd ios && pod install && cd ..
 ```
 
-If you are planning to use image picker, there are some additional steps to be done. You can find them here - https://github.com/react-native-community/react-native-image-picker/blob/master/docs/Install.md
+If you are planning to use an image picker, there are some additional steps to be done. You can find them here - https://github.com/react-native-community/react-native-image-picker/blob/master/docs/Install.md
 
 If you are planning to use file/document picker, you need to enable iCloud capability in your app - https://github.com/Elyx0/react-native-document-picker#reminder
 
@@ -259,13 +262,13 @@ react-native run-ios
 
 **Note for Android**:
 
-If you are using androidx app:
+If you are using AndroidX app:
 
 > AndroidX is a major step forward in the Android ecosystem, and the old support library artifacts are being deprecated. For 0.60, React Native has been migrated over to AndroidX. This is a breaking change, and your native code and dependencies will need to be migrated as well.
 
-(reference: https://facebook.github.io/react-native/blog/2019/07/03/version-60#androidx-support)
+(Reference: https://facebook.github.io/react-native/blog/2019/07/03/version-60#androidx-support)
 
-In current context, dependencies such as `react-native-document-picker` and (if you are using `react-navigation`) `react-native-gesture-handler`, `react-native-reanimated` don't have androidx support. But awesome tool named [jetifier](https://github.com/mikehardy/jetifier) is quite useful to patch these dependencies with androidx support.
+In current context, dependencies such as `react-native-document-picker` and (if you are using `react-navigation`) `react-native-gesture-handler`, `react-native-reanimated` don't have AndroidX support. But an awesome tool named [jetifier](https://github.com/mikehardy/jetifier) is quite useful to patch these dependencies with AndroidX support.
 
 **NOTE** If you are planning to use file picker functionality, make sure you enable iCloud capability in your app
 
@@ -276,15 +279,15 @@ In current context, dependencies such as `react-native-document-picker` and (if
 - Upgrade from 0.1.x to 0.2.x:
 
   - 0.2.x added support for react native 0.60. Dependencies like `react-native-image-picker`, `react-native-document-picker` and `netinfo` have been taken out of hard dependencies and moved to peer dependencies and thus will have to be installed manually on consumer end ([Reference](https://github.com/GetStream/stream-chat-react-native/pull/52/files#diff-83a54d8caab0ea9fcdd5f832b03a5d83))
-  - React native 0.60 came with autolinking functionality, that means if some native libraries are linked manually before upgrade, they will have to be unlinked so that react native can autolink them ([Reference](https://facebook.github.io/react-native/blog/2019/07/03/version-60#native-modules-are-now-autolinked))
+  - React Native 0.60 came with auto-linking functionality that means if some native libraries are linked manually before the upgrade, they will have to be unlinked, so that React Native can auto-link them ([Reference](https://facebook.github.io/react-native/blog/2019/07/03/version-60#native-modules-are-now-autolinked))
 
     ```
     react-native unlink react-native-image-picker
     react-native unlink react-native-document-picker
     react-native unlink @react-native-community/netinfo
     ```
 
-  - React native 0.60 has been migrated over to AndroidX. In current context, dependencies such as `react-native-document-picker` and (if you are using `react-navigation`) `react-native-gesture-handler`, `react-native-reanimated` don't have androidx support. But awesome tool named [jetifier](https://github.com/mikehardy/jetifier) is quite useful to patch these dependencies with androidx support.
+  - React Native 0.60 has been migrated over to AndroidX. In the current context, dependencies such as `react-native-document-picker` and (if you are using `react-navigation`) `react-native-gesture-handler`, `react-native-reanimated` don't have AndroidX support. But an excellent tool named [jetifier](https://github.com/mikehardy/jetifier) is quite useful to patch these dependencies with AndroidX support.
 
   - CocoaPods are not part of React Native's iOS project ([ref](https://facebook.github.io/react-native/blog/2019/07/03/version-60#cocoapods-by-default)). Thus make sure to install all the pod dependencies.
 
@@ -294,11 +297,11 @@ In current context, dependencies such as `react-native-document-picker` and (if
 
 ## Common issues
 
-#### While running native example, you may (not necessarily) run into following issues:
+#### While running native example, you may (not necessarily) run into the following issues:
 
-1. When you execute `react-native run-ios` for the first time, it starts a metro bundler in parallel. It can result into some errors, since build process isn't complete yet. Try the following to fix this:
+1. When you execute `react-native run-ios` for the first time, it starts a metro bundler in parallel. It can result in some errors since the build process isn't complete yet. Try the following to fix this:
    1. Close/stop the metro bundler process.
-   2. Let the build process finish completely, it can take usually around 2-3 minutes for the first time.
+   2. Let the build process finish. It can usually take around 2-3 minutes for the first time.
    3. Start the metro bundler manually by executing `yarn start` inside `stream-chat-react-native/examples/NativeMessaging` directory.
 2. When you execute `react-native run-android`, you may (not necessarily) run into following error:
 
@@ -326,7 +329,7 @@ In current context, dependencies such as `react-native-document-picker` and (if
    error Command failed: ./gradlew app:installDebug. Run CLI with --verbose flag for more details.
    ```
 
-   To resolve this, do the following
+   To resolve this, do the following.
 
    1. Craete a file named `local.properties` inside `stream-chat-react-native/examples/NativeMessaging/android` directory
    2. Put the this line in that file. Make sure sdk path is correctly mentioned as per your system:
@@ -337,8 +340,8 @@ In current context, dependencies such as `react-native-document-picker` and (if
 
 ## Internationalisation
 
-Instance of class `Streami18n` should be provided to Chat component to handle translations.
-Stream provides following list of in-built translations for components:
+Instance of class `Streami18n` should be provided to the Chat component to handle translations.
+Stream provides the following list of built-in translations for components:
 
 1.  English (en)
 2.  Dutch (nl)
@@ -348,7 +351,7 @@ Stream provides following list of in-built translations for components:
 6.  Italian (it)
 7.  Hindi (hi)
 
-Default language is English. Simplest way to start using chat components in one of the in-built languages would be following:
+The default language is English. The simplest way to start using chat components in one of the in-built languages is the following:
 
 Simplest way to start using chat components in one of the in-built languages would be following:
 
@@ -374,7 +377,7 @@ const i18n = new Streami18n({
 
 You can find all the available keys here: https://github.com/GetStream/stream-chat-react-native/tree/master/src/i18n
 
-They are also exported as json object from the library.
+They are also exported as a JSON object from the library.
 
 ```js static
 import {
@@ -393,5 +396,5 @@ Please read this docs on i18n for more details and further customizations - http
 
 ## Contributing
 
-We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and test all the changes. Please check our [dev setup docs](https://github.com/GetStream/stream-chat-react-native/wiki/Dev-setup-for-contributing-to-the-library) to get you started. We are very happy to merge your code in the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.
+We welcome code changes that improve this library or fix a problem, and please make sure to follow all best practices and test all the changes. Please check our [dev setup docs](https://github.com/GetStream/stream-chat-react-native/wiki/Dev-setup-for-contributing-to-the-library) to get you started. We are pleased to merge your code into the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.