v1.0.1

Author: vivekCometChat

README.md

@@ -1,102 +1,141 @@
-<div style="width:100%">
-	<div style="width:50%; display:inline-block">
-		<p align="center">
-         <img align="center" src="https://avatars2.githubusercontent.com/u/45484907?s=200&v=4"/>
-		</p>	
-	</div>	
+<!-- PROJECT LOGO -->
+<p align="left">
+  <a href="https://cometchat.com">
+    <img src="./Screenshots/logo.png" alt="CometChat logo" width="180" height="180">
+  </a>
+
+<h2 align="left">Android Java Sample App</h3>
+
+  <p align="left">
+    CometChat Kitchen Sink Sample App (built using <b>CometChat UI Kits</b>) is a fully functional real-time messaging app capable of private (one-on-one), group messaging, voice & video calling.
+    <br />
+    <a href="https://www.cometchat.com/docs/v4/android-uikit/overview"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/cometchat-pro/cometchat-chat-sample-app-android-java/issues">Report Bug</a>
+  </p>
+</p>
+
+<div align="left">
+    <a href="https://github.com/cometchat-pro/android-java-chat-app/releases/" alt="Releases">
+        <img src="https://img.shields.io/github/v/release/cometchat-pro/android-java-chat-app" />
+    </a>
+    <a href="https://img.shields.io/github/languages/top/cometchat-pro/android-java-chat-app">
+        <img src="https://img.shields.io/github/languages/top/cometchat-pro/android-java-chat-app" />
+    </a>
+    <a href="https://github.com/cometchat-pro/android-java-chat-app/stargazers">
+        <img src="https://img.shields.io/github/stars/cometchat-pro/android-java-chat-app?style=social" />
+    </a>
+    <a href="https://twitter.com/CometChat">
+        <img src="https://img.shields.io/twitter/follow/CometChat?label=CometChat&style=social" />
+    </a>
 </div>
-</br></br>
 
-> **Note**
+<!-- TABLE OF CONTENTS -->
 
-Version 4 CometChat UI Kits 
+## Table of Contents
 
-We’ve introduced a major update to CometChat UI kits. Version 4 features a modular architecture that gives you enhanced flexibility to build and customize your web and mobile apps. Please switch to the branch [v4](https://github.com/cometchat-pro/cometchat-chat-sample-app-android-java/tree/v4) to check out the sample app based on this version. [Visit our documentation](https://www.cometchat.com/docs/android-v4-uikit/overview) to read more about this.
-<br/><br/>
+- [About the Project](#about-the-project)
+    - [Built With](#built-with)
+- [Getting Started](#getting-started)
+    - [Dependencies](#dependencies)
+    - [Installing](#installing)
+    - [Usage](#usage)
+        - [Run locally](#run-project-locally)
+    - [Help](#help)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
+- [About Authors](#about-authors)
 
-# Android Java Chat App
+<!-- ABOUT THE PROJECT -->
 
-[![Platform](https://img.shields.io/badge/Platform-Android-brightgreen.svg)](#)
-[![Platform](https://img.shields.io/badge/Language-Java-yellowgreen.svg)](#)
-<img src="https://img.shields.io/badge/Repo%20Size-18.6%20MB-blue" />
-![GitHub contributors](https://img.shields.io/github/contributors/cometchat-pro/android-java-chat-app)
-![GitHub stars](https://img.shields.io/github/stars/cometchat-pro/android-java-chat-app?style=social)
-![Version](https://shields.io/badge/version-v3.0.9--1-orange)
-![Twitter Follow](https://img.shields.io/twitter/follow/cometchat?style=social)
+## About The Project
 
-<img src="https://files.readme.io/952af91-UI_Kit__1.png"/>
-<br>
+CometChat Kitchen Sink Sample App (built using **CometChat UI Kit**) is a fully functional real-time messaging app capable of private (one-on-one), group messaging, voice & video calling.
 
-CometChat Kitchen Sink Sample App (built using CometChat UIKit) is a fully functional messaging app capable of one-on-one (private) and group messaging as well as Calling. This sample app enables users to send text and multimedia messages like images, videos, documents. Also, users can make Audio and Video calls to other users or groups.**
-<br/>
-<hr/>
+### Built With
 
-## Prerequisites :star:
-Before you begin, ensure you have met the following requirements:<br/>
- ✅ &nbsp; You have `Android Studio` installed in your machine.<br/>
- ✅ &nbsp; You have a `Android Device or Emulator` with Android Version 6.0 or above.<br/>
- ✅ &nbsp; You have read [CometChat Key Concepts](https://www.cometchat.com/docs/java-chat-ui-kit/key-concepts).<br/>
+- [Android](https://developer.android.com/)
+- [CometChat](https://cometchat.com)
 
-<hr/>
+<!-- GETTING STARTED -->
 
-## Installing Android Java Chat UI Kit :wrench:
+## Getting Started
 
-Simply clone the project from [android-java-chat-app](https://github.com/cometchat-pro-samples/android-java-chat-app/) repository.
+Simply clone or fork this repo and run it using the instructions below to see all features in action. Or use it as a starter template/boilerplate and make edits to suit your needs.
 
+## Dependencies
 
-### Running the sample app
+- CometChat - [Sign up for CometChat](https://app.cometchat.com) and create an app to obtain your keys and other credentials
 
-To Run to sample app you have to do the following changes by Adding **APP_ID**, **AUTH_KEY** and  **REGION_CODE**
+## Installing
 
-   You can obtain your  *APP_ID*, *AUTH_KEY* and *REGION_CODE* from [CometChat Dashboard](https://app.cometchat.com/)
+1. Clone the repo
 
-   - Open the project in Android Studio.
+   ```sh
+   git clone https://github.com/cometchat-pro/cometchat-chat-sample-app-android-java.git
+   ```
 
-   - Modify `APP_ID` and `AUTH_KEY` and `REGION` with your own .
+2. Change to the working directory
 
-   -  Select demo users or enter the **UID** at the time of login once the app is launched.
+   ```sh
+   cd cometchat-chat-sample-app-android-java
+   ```
 
-<img align="center" width="100%" height="auto"
-src="https://files.readme.io/9f23df2-app_credentials.png">
+3. Change the Branch
 
-Build and run the Sample App.
-</hr>
+   ```sh
+   git checkout v4
+   ```
 
-# Learn more about UIKit
+4. Replace `APP_ID`, `REGION`, and `AUTH_KEY` with your CometChat `App ID`, `Region`, and `Auth Key` in `AppConstants.java` file.
 
-Learn more about how to integrate [UI Kit](https://github.com/cometchat-pro/android-java-chat-ui-kit/blob/master/README.md) inside your app.
-<br/>
-<hr/>
+   ![Replacing constants in AppConstants.java](./Screenshots/credentials.png "Replacing constants in AppConstants.java")
 
-## Troubleshooting
+<!-- USAGE EXAMPLES -->
 
-- To read the full documentation on UI Kit integration visit our [Documentation](https://www.cometchat.com/docs/java-chat-ui-kit/overview).
+## Usage
 
-- Facing any issues while integrating or installing the UI Kit please <a href="https://app.cometchat.com/"> connect with us via real time support present in CometChat Dashboard.</a>.
+This app contains all features offered by CometChat through its UI Kit. [Read more about the Android UI Kit here.](https://www.cometchat.com/docs/v4/android-uikit/overview)
 
----
+### Run project locally
 
+- Open the project in Android Studio.
 
-## Contributors
+    - Build and run the Sample App.
+    -  Select demo users or enter the **UID** at the time of login once the app is launched.
 
-Thanks to the following people who have contributed to this project:
+To learn about Android UI Kit Integration, please [click here](https://www.cometchat.com/docs/v4/android-uikit/integration).
 
-[👨‍💻 @vivekprajapati 💻](https://github.com/vivekCometChat) <br>
-[👨‍💻 @darshanbhanushali 💻](https://github.com/darshanbhanushali) <br>
-[👨‍💻 @yadavmangesh 💻](https://github.com/yadavmangesh) 
+## Help
 
-[Contribution guidelines for this project]()
+To learn more about our UI kits, visit our [documentation](https://www.cometchat.com/docs/v4-uikits).
 
----
+If you are still facing issues while running this project or integrating with our UI Kits, please connect with our real-time support via the [CometChat Dashboard](https://app.cometchat.com/).
 
-## :mailbox: Contact
+<!-- CONTRIBUTING -->
 
-Contact us via real time support present in [CometChat Dashboard.](https://app.cometchat.com/)
+## Contributing
 
----
+Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. Sincere thanks to all our [contributors](https://github.com/cometchat-pro/android-java-chat-app/graphs/contributors)!
+
+You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.
+
+## Support
+
+Please connect with our real-time support via the [CometChat Dashboard](https://app.cometchat.com/).
+
+<!-- LICENSE.md -->
 
 ## License
 
-This project uses the following license: [License.md](LICENSE.md).
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE.md) file for details.
+
+## About Authors
+
+`cometchat-chat-sample-app-android-java` is created & maintained by CometChat.
 
+The names and logos for CometChat are trademarks of CometChat, Inc.
 
+We love open-source software! See [our other projects](https://github.com/cometchat-pro) or [sign up with us](https://app.cometchat.com) to start using our product.