Update README.md

README.md

@@ -1,10 +1,84 @@
-# AndroidIDE 
-An IDE to develop Android Apps on Android Smartphones. Supports Gradle Build System and OpenJDK 11.0.1
+# AndroidIDE
+AndroidIDE is an IDE for Android to develop full featured Android apps on Android smartphones.
 
+This repository is used to manage issues, feature requests and discussions related to AndroidIDE.
 
-# License 
-AndroidIDE is licensed under version 3 of the GNU General Public License.
+You should report bugs and suggest features/enhancements [here](https://github.com/itsaky/AndroidIDE/issues).
+Describe the issue/request briefly. Provide steps to reproduce the issue. If you need any help, you should discuss it [here](https://t.me/androidide_discussions).
 
+If you open a build related issue, please provide these details:
+- Device model
+- Android Version
+- Full build output with stacktrace.
+
+### Main Features
+- Supports Gradle
+- Comes with OpenJDK 11.0.12
+- Provides auto completion for Java and XML. It also has basic (reserved) completion for Gradle files.
+
+More features will be implemented as we continue to develop this app.
+
+### Features to be implemented
+- [x] Advanced Java Auto Complete
+- [x] Terminal
+- [x] Custom environment variables (for Build & Terminal)
+- [x] SDK Manager (Available via terminal)
+- [x] Gradlew support (with some limitations)
+- [x] API information for classes and their members (since, removed, deprecated).
+- [ ] UI Designer
+- [ ] Layout Inspector
+- [ ] String Translator
+- [ ] Asset Studio (Drawable & Icon Maker)
+- [ ] Git
+
+### Limitations
+- Gradlew is supported. But, it requires that the project's application module is named 'app'. 
+- SDK Manager is already included in Android SDK and is accessible in AndroidIDE via its Terminal. But, you cannot use it to install some tools (like NDK) because those tools are not built for Android.
+- No official NDK support because we haven't built the NDK for Android.
+- No Android Gradle Plugin versions other than v7.0.2 are supported (due to AAPT2).
+
+The app is still being developed actively. It's in beta stage and may not be stable. if you have any issues using the app, please let us know.
+
+### Screenshots
+| Main Screen | Terminal |
+| ----------- | -------- |
+| <img src="images/main_screen.jpg" width="100" height="200" alt="AndroidIDE Main Screen" /> | <img src="images/terminal.jpg" width="100" height="200" alt="AndroidIDE Terminal" /> |
+
+| Build Output | Java Completion |
+| ------------ | --------------- |
+| <img src="images/build_output.jpg" width="100" height="200" alt="AndroidIDE Build Output" /> | <img src="images/java_completion.jpg" width="100" height="200" alt="AndroidIDE Java Completion" /> |
+
+| XML Completion | Screenshot |
+| -------------- | ---------- |
+| Widgets | <img src="images/xml_completion_widgets.jpg" width="100" height="200" alt="AndroidIDE XML Completion - Widgets" />
+| Attributes | <img src="images/xml_completion_attributes.jpg" width="100" height="200" alt="AndroidIDE XML Completion - Attributes" />
+| Attribute Values | <img src="images/xml_completion_enums.jpg" width="100" height="200" alt="AndroidIDE XML Completion - Attribute Values" />
+
+| Gradle Support | File Tree |
+| -------------- | --------- |
+| <img src="images/gradle_buildscript.jpg" width="100" height="200" alt="AndroidIDE Gradle Support" /> | <img src="images/file_tree.jpg" width="100" height="200" alt="AndroidIDE File Tree" /> |
+
+### Posts to help you get started
+- [Installing AndroidIDE](https://telegra.ph/How-to-install-AndroidIDE-09-11)  
+  - Author: [Marvin Stelter](https://github.com/MarvinStelter)
+- [Create your first project](https://itsaky.github.io/create-your-first-project-in-androidIDE/)  
+  - Author: [Akash Yadav](https://github.com/itsaky)
+
+### DEVELOPERS
+This project was initially developed by [Akash Yadav](https://github.com/itsaky) and [Marvin Stelter](https://github.com/MarvinStelter). We appreciate the efforts of anyone who contributes to this project.
+
+### Special Thanks
+- [Rosemoe](https://github.com/Rosemoe) for the awesome [CodeEditor](https://github.com/Rosemoe/sora-editor)
+- [Termux](https://github.com/termux) for [Terminal Emulator](https://github.com/termux/termux-app)
+- [Bogdan Melnychuk](https://github.com/bmelnychuk) for [AndroidTreeView](https://github.com/bmelnychuk/AndroidTreeView)
+- [George Fraser](https://github.com/georgewfraser) for the [Java Language Server](https://github.com/georgewfraser/java-language-server)
+- [Eclipse Foundation](https://github.com/eclipse) for [LSP4J](https://github.com/eclipse/lsp4j)
+
+### Contact Us
+- [Website](https://androidide.com)
+- [Telegram](https://t.me/androidide_discussions)
+
+### License 
 ```
 AndroidIDE is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by