aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 11 insertions, 17 deletions
diff --git a/README.md b/README.md
index 1702a82..eabd654 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,15 @@
-# TODO
+# Kulinar
-## Before publish
+This simple and efficient cooking app is designed to improve your time with recipes.
+Organize, share and read recipes easily and comfortably.
-- working import / export
-- make recipe titles changeable across sessions
-- compress / encode exports and internal images
-- add settings explanations / subtitles
-- change info links
+# Installation
-## Next update
+This app is available on the Google Play Store.
-- average color background for recipe images
-- add search based on ingridients, ie write noodle, get auflauf, noodle salad etc
-
-## Unsure
-
-- provide recipes over server(s), show source
-- scheduling system
-- voting system
-- multiple images per recipe
+It can also be compiled and installed from source using flutter.
+First make sure your device is connected, has enough storage and you have permission to install the app.
+Next, in the root directory of this repo run:
+```bash
+flutter install
+```