Skip to content

Commit 17e243f

Browse files
committed
Edit README
Add short description for project, how to run the project, and tested environment.
1 parent f0c6617 commit 17e243f

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
PostMaker
22
=========
33

4-
Simple social media application for Android.
4+
Simple app to post content for Android. This app utilizes Firebase as backend services, i.e.
5+
Firebase SDK Authentication and Firebase Realtime Database. Signed in users can post to a timeline,
6+
view posts, and delete his/her own post.
7+
8+
### How to run
9+
1. You need to set up your own Firebase Project in [Firebase Console](https://console.firebase.google.com).
10+
Spark plan is free with a certain limit.
11+
2. Once set up, download and place your `google-services.json` in `/app` directory.
12+
3. Build and run this project.
13+
14+
### Tested Environment
15+
1. Android Device minimum API Level 19
16+
2. Built using Android Studio 3.2.1
517

618
License
719
=======

0 commit comments

Comments
 (0)