add basic readme

bmcmahen · Jul 30, 2019 · 810b51b · 810b51b
1 parent 0d7518d
commit 810b51b
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ npm-debug.*
 *.orig.*
 web-build/
 web-report/
+.DS_Store
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+# Roast Buddy
+
+<div align="center">
+    <img
+    max-width="600px"
+    alt="Two screenshots of Roast Buddy."
+     src="https://raw.githubusercontent.com/bmcmahen/roast-buddy-reloaded/master/hero.jpg">
+
+</div>
+<br />
+
+Roast Buddy is a mobile app which helps you keep track of your coffee roasting. It's built using React-Native.
+
+## Development
+
+Clone this repository and install the dependencies using `yarn`. You'll also need to have `expo` installed.
+
+```
+yarn run start
+```
+
+## License
+
+BSD 3-Clause.
diff --git a/hero.jpg b/hero.jpg