added ReadMe

aslanyanhaik · Jan 4, 2017 · abf82f3 · abf82f3
1 parent 6111e1e
commit abf82f3
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 2 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/QuickChat.xcworkspace/contents.xcworkspacedata b/QuickChat.xcworkspace/contents.xcworkspacedata
diff --git a/QuickChat.xcworkspace/xcuserdata/Haik.xcuserdatad/UserInterfaceState.xcuserstate b/QuickChat.xcworkspace/xcuserdata/Haik.xcuserdatad/UserInterfaceState.xcuserstate
diff --git a/README.md b/README.md
@@ -1,2 +1,36 @@
-# Quick-Chat
-Real time chat app using Firebase
+# Quick Chat for iOS
+
+Quick Chat for iOS is a real time chat app based on Firebase developed by [Haik Aslanyan](https://twitter.com/aslanyanhaik) and written in Swift 3.
+
+Quick Chat allows to send and receive text messages, photos & location.
+
+![Screenshots of Quick Chat for iOS](screenshot1.png "Screenshots of Quick Chat for iOS")
+
+## Getting Started
+
+To get started and run the app, you need to follow these simple steps:
+
+1. Open the QuickChat workspace in Xcode.
+2. Change Bundle Identifier to match your domain.
+3. Go to [Firebase](https://firebase.google.com) and create new project.
+4. Select "Add Firebase to your iOS app" option, type bundle Identifier & click continue.
+5. Download "GoogleService-Info.plist" file and add to project. Make sure file name is "GoogleService-Info.plist".
+6. You're all set! Run Quick Chat on your iPhone or the iOS Simulator.
+
+![Screenshots of Quick Chat for iOS](screenshot2.png "Screenshots of Quick Chat for iOS")
+
+## Compatibility
+
+This project is written in Swift 3.0 and requires Xcode 8.2 to build and run.
+
+Quick Chat for iOS is compatible with iOS 9.1+.
+
+## Authors
+
+* [Haik Aslanyan](https://twitter.com/aslanyanhaik)
+
+## License
+
+Copyright 2017 Haik Aslanyan.Twitter, Inc. and contributors.
+
+Licensed under MIT License: https://opensource.org/licenses/MIT
diff --git a/screenshot1.png b/screenshot1.png
diff --git a/screenshot2.png b/screenshot2.png