Merge pull request #191 from ente-io/update-readme

README.md

@@ -1,20 +1,70 @@
-Android and iOS apps for [ente](https://ente.io) built with lots of :heart: and a little bit of [Flutter](https://flutter.dev).
+# ente - simple, safe photo storage
 
-You can grab the latest build from:
-- [GitHub](https://github.com/ente-io/frame/releases/latest)
-- [PlayStore](https://play.google.com/store/apps/details?id=io.ente.photos)
-- [AppStore](https://apps.apple.com/in/app/ente-photos/id1542026904)
+**ente** is a cloud storage provider that provides end-to-end encryption for your data.
 
-You can read more about ente's encryption protocol here: https://ente.io/architecture.
+We have open-source apps across Android, iOS, web and desktop that automatically backup your photos and videos.
 
-For more information about the project please visit: https://ente.io.
+This repository contains the code for our mobile apps, built with a lot of ❤️, and a little bit of [Flutter.](https://flutter.dev)
+![App Screenshots](https://user-images.githubusercontent.com/1161789/154794909-c391f947-266f-4298-956b-a67b5eb9a169.png)
 
----
+## ✨ Features
+
+- Client side encryption (only you can view your photos and videos)
+- Background sync
+- Shareable links for albums
+- Highlights of memories from previous years
+- Ability to detect and delete duplicate files
+- Image editor
+- EXIF viewer
+- Ability to free up disk space by deleting backed up photos
+- Recycle bin
+- 2FA
+- Lockscreen
+- Zero third-party tracking / analytics
+
+## 📲 Installation
+
+### Android
+
+This repository's GitHub releases contains APKs, built straight from source. The latest build is available @ [ente.io/apk](https://ente.io/apk). These builds keep themselves updated, without relying on third party stores.
+
+You can alternatively install the build from PlayStore.
+
+<a href="https://play.google.com/store/apps/details?id=io.ente.photos">
+  <img width="197" alt="Download on Google Play" src="https://user-images.githubusercontent.com/1161789/154795146-e7590d31-7636-4eee-b404-e2dc05fa25b7.png">
+</a>
+
+
+### iOS
+<a href="https://apps.apple.com/in/app/ente-photos/id1542026904">
+  <img width="197" alt="Download on AppStore" src="https://user-images.githubusercontent.com/1161789/154795157-c4468ff9-97fd-46f3-87fe-dca789d8733a.png">
+</a>
+
+
+## 🧑‍💻 Building from source
 
-## Building
 1. [Install Flutter](https://flutter.dev/docs/get-started/install)
-2. Run `flutter build apk --release --flavor independent`
+2. Clone this repository with `git clone git@github.com:ente-io/frame.git` 
+3. Pull in all submodules with `git submodule init --update-recursive`
+4. For Android, run `flutter build apk --release --flavor independent`
+5. For iOS, run `flutter build ios` 
 
----
+## 🙋 Help
 
-If there's something you need help with, please write to [support@ente.io](mailto:support@ente.io), we'd be happy to help!
+We provide human support to our customers. Please write to [support@ente.io](mailto:support@ente.io) sharing as many details as possible about whatever it is that you need help with, and we will get back to you as soon as possible.
+
+## 🧭 Roadmap
+
+We maintain a public roadmap, that's driven by our community @ [roadmap.ente.io](https://roadmap.ente.io).
+
+## 🤗 Support
+
+If you like this project, please consider upgrading to a paid subscription.
+
+If you would like to motivate us to keep building, you can do so by [starring](https://github.com/ente-io/frame/stargazers) this project.
+
+## ❤️ Join the Community
+
+Follow us on [Twitter](https://twitter.com/enteio) and join [r/enteio](https://reddit.com/r/enteio) to get regular updates, connect with other customers, and discuss your ideas.
+
+An important part of our journey is to build better software by consistently listening to community feedback. Please feel free to [share your thoughts](mailto:feedback@ente.io) with us at any time.