feat: update readme (#58)

README.md

@@ -1,52 +1,88 @@
-
- [<img align="right" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/instagram.svg" width="50" height="50" />](http://www.instagram.com/gajjartejas)
- [<img align="right" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/twitter.svg" width="50" height="50" />](http://www.twitter.com/gajjartejas)
+[<img align="right" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/instagram.svg" width="50" height="50" />](http://www.instagram.com/gajjartejas)
+[<img align="right" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/twitter.svg" width="50" height="50" />](http://www.twitter.com/gajjartejas)
 
-# Introduction [WORK IN PROGRESS]
+# Introduction
 
-Kano - An interective way to learn Gujarati
+Learn Gujarati alphabets, numbers, and more...
 
 ## Installation
 
-Coming soon...
+Get the app from Google Play [Paid]:
+
+<a href="https://play.google.com/store/apps/details?id=com.tejasgajjar.kano">
+ <img alt="Android app on Google Play" src="https://developer.android.com/images/brand/en_generic_rgb_wo_60.png" />
+</a>
 
 ### Screenshots
 
-Coming soon...
+| | | | |
+|:------------------------------------------:|:-----------------------------------------------:|:-------------------------------------------:|:--------------------------------------------:|
+| ![Home](docs/images/v1.0/screenshot-1.png) | ![Sub Items](docs/images/v1.0/screenshot-2.png) | ![Chart](docs/images/v1.0/screenshot-3.png) | ![Detail](docs/images/v1.0/screenshot-4.png) |
+
 
-The application supports Android 6.0 (API 23) and above.
+| | | | |
+|:------------------------------------------------------:|:-----------------------------------------------------------:|:------------------------------------------------------------:|:--------------------------------------------------------:|
+| ![Stroke Direction](docs/images/v1.0/screenshot-5.png) | ![Animated Stroke Order](docs/images/v1.0/screenshot-6.png) | ![Swipe Cards with audio](docs/images/v1.0/screenshot-7.png) | ![Learn and Practice](docs/images/v1.0/screenshot-8.png) |
 
+The application supports Android 5.0 (API 21+) and above.
 
 ## Features include:
 
-* Simple card UI and simple navigations.
-* Dark theme support.
+- Characters Chart
+ - Explore characters, their details, and animations.
+ - Easily navigate by swiping.
+- Learn in Sequence
+ - Sequentially learn alphabets and numbers.
+ - Swipe through interactive cards with audio.
+- Learn by Selected Characters
+ - Customize learning by picking specific characters.
+- Practice by Order
+ - Test your knowledge matching characters.
+ - Swipe through cards for practice.
+- Practice by Selected Characters
+ - Focus on specific characters.
+ - Practice matching as in "Practice by Order."
+
+## Additional Features
+
+- Simple card UI and simple navigations.
+- Dark theme support.
+- Tablet, iPad and Landscape support.
 
 ## Building
 
-### With Gradle
+### Basic setup
+
 If you want to build from source, just do
 
  git clone https://github.com/gajjartejas/Kano.git
  cd Kano
- npm install or yarn
- ./gradlew build
+ `npm install` or `yarn`
+ cd ios && pod install && cd..
 
 ### With Android Studio
 
 1. Clone repo `git clone https://github.com/gajjartejas/Kano.git`
-2. In Android Studio selection "Open an existing Android Studio Project"
-3. Wait for Gradel to sync and then run or build.
+2. In Android Studio select "Open an existing Android Studio Project"
+3. Add `GoogleService-Info.json` file. (you need to create a firebase project then copy and paste it)
+4. Wait for Gradel to sync and then run or build.
+
+### With Xcode
+
+1. Clone repo `git clone https://github.com/gajjartejas/Kano.git`
+2. Navigate to `Kano/ios` and open `OpenHardwareMonClient.xcworkspace` folder.
+3. Add `GoogleService-Info.plist` file. (you need to create a firebase project then copy and paste it)
+4. Run the project.
 
 ## Contributing
 
 There are many ways you can contribute to the development.
 
-* Pull requests are always welcome! 
-* You must respect conventional commits for your commits and MR title.
-* You can merge only if your CI is green.
-* give priority to squash and merge, and not merge with a merge commit
-* Please visit [app.tolgee.io](https://app.tolgee.io/projects/501/translations) in order to update and create new translations
+- Pull requests are always welcome!
+- You must respect conventional commits for your commits and PR/MR title.
+- You can merge only if your CI is green.
+- give priority to squash and merge, and not merge with a merge commit
+- Please visit [app.tolgee.io](https://app.tolgee.io/projects/501/translations) in order to update and create new translations
 
 ## License
 

docs/faqs.md

@@ -3,4 +3,5 @@
 - [What are the system requirements of this app?](#what-are-the-system-requirements-of-this-app)
 
 ## What are the system requirements of this app?
-Android 6.0 (API 23) and above.
+
+The application supports Android 5.0 (API 21+) and above.

docs/privacy.md

@@ -17,7 +17,6 @@ The app does use third-party services that may collect information used to ident
 Link to the privacy policy of third-party service providers used by the app
 
 * [Google Play Services](https://www.google.com/policies/privacy/)
-* [Google Analytics for Firebase](https://firebase.google.com/policies/analytics)
 * [Firebase Crashlytics](https://firebase.google.com/support/privacy/)
 
 **Log Data**
@@ -63,4 +62,4 @@ This policy is effective as of 2022-03-26
 
 If you have any questions or suggestions about my Privacy Policy, do not hesitate to contact me at [email protected].
 
-This privacy policy page was created at [privacypolicytemplate.net](https://privacypolicytemplate.net) and modified/generated by [App Privacy Policy Generator](https://app-privacy-policy-generator.nisrulz.com/)
+This privacy policy page was created at [privacypolicytemplate.net](https://privacypolicytemplate.net) and modified/generated by [App Privacy Policy Generator](https://app-privacy-policy-generator.nisrulz.com/)

docs/terms.md

@@ -11,7 +11,6 @@ The app does use third-party services that declare their Terms and Conditions.
 Link to Terms and Conditions of third-party service providers used by the app
 
 * [Google Play Services](https://policies.google.com/terms)
-* [Google Analytics for Firebase](https://firebase.google.com/terms/analytics)
 * [Firebase Crashlytics](https://firebase.google.com/terms/crashlytics)
 
 You should be aware that there are certain things that Tejas Gajjar will not take responsibility for. Certain functions of the app will require the app to have an active internet connection. The connection can be Wi-Fi or provided by your mobile network provider, but Tejas Gajjar cannot take responsibility for the app not working at full functionality if you don’t have access to Wi-Fi, and you don’t have any of your data allowance left.
@@ -34,4 +33,4 @@ These terms and conditions are effective as of 2022-03-26
 
 If you have any questions or suggestions about my Terms and Conditions, do not hesitate to contact me at [email protected].
 
-This Terms and Conditions page was generated by [App Privacy Policy Generator](https://app-privacy-policy-generator.nisrulz.com/)
+This Terms and Conditions page was generated by [App Privacy Policy Generator](https://app-privacy-policy-generator.nisrulz.com/)