diff --git a/README.md b/README.md index 334265d..1337279 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# birb +# Birb + Instagram for birds + +Birb is an open source [Flutter](https://flutter.io) app written as part the [A month of Flutter](https://bendyworks.com/blog/a-month-of-flutter) blog series. + +## Install + +Make sure you have [Flutter](https://flutter.io/docs/get-started/install) installed and either Android Emulator or iOS Simulator configured. + +Clone the birb repository: + +~~~bash +git clone git@github.com:abraham/birb.git +~~~ + +Install the Flutter dependencies within the `app` directory: + +~~~bash +flutter pub get +~~~ + +[Start the app](https://flutter.io/docs/get-started/test-drive).