update readme

2021-02-04 17:58:49 +01:00
parent c5bf54b46a
commit 15254b9ae2
3 changed files with 97 additions and 25 deletions
@@ -1 +1,36 @@
-# flutter-samples
+# Flutter samples
+
+![](https://raw.githubusercontent.com/GetStream/flutter-samples/master/images/sdk_hero_v4.png)
+
+## What is Stream?
+
+Stream allows developers to rapidly deploy scalable feeds and chat messaging with an industry leading 99.999% uptime SLA guarantee.
+
+With Stream's chat components, developers quickly add chat to their app for a variety of use-cases:
+
+- Livestreams like Twitch or Youtube
+- In-Game chat like Overwatch or Fortnite
+- Team style chat like Slack
+- Messaging style chat like Whatsapp or Facebook's messenger
+- Commerce chat like Drift or Intercom
+
+## Repo Overview 😎
+
+This repo contains projects and samples developed by the team and Stream community. Projects are broke up into directories containing the source code for each project. 
+
+## **Projects 🚀**
+
+- [Stream Chat v1](https://github.com/GetStream/flutter-samples/tree/main/stream_chat_v1): a sample app implemented using Stream Chat and Flutter. It is a fully fledged messaging app built using a combination of our pre-made widgets and custom Flutter widgets.
+
+## Requirements 🛠
+
+Before running this project please ensure Flutter is installed and configured on your machine. If you're new to Flutter, please checkout the [official guide](https://flutter.dev/docs/get-started/install) with installation instructions for your OS. 
+
+## Contributing
+
+- How can I submit a sample app?
+    - Apps submissions are always welcomed! 🥳 Open a pr with a proper description and we'll review it as soon as possible
+- Spot a bug 🕷 ?
+    - We welcome code changes that improve the apps or fix a problem. Please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github.
+
+[Stream Chat v1 Readme](https://www.notion.so/Stream-Chat-v1-Readme-c02de873a35c425cb9672ddfee2f49e7)