added installation instructions

.gitignore

@@ -126,7 +126,6 @@ dist
 
 # vuepress v2.x temp and cache directory
 .temp
-.cache
 
 # Docusaurus cache and generated files
 .docusaurus
@@ -155,5 +154,7 @@ dist
 
 # custom
 
+database/data.db
+
 #
 .idea

README.md

@@ -1,11 +1,8 @@
 # GiacPoints
 
 A system for keeping track of house chores completed and attributing points to the activities.
-
-# Functionality
-
-Webpage - Login, add chores/activities (admin), tick of chores (user), log of completed chores (all)
-
-API layer - /loginUser, /getTasks, /completeTask, /getHistory?filter, /addTask 
-
-Backend - DB, user (name password userid role), activities (taskid name points), history (userid taskid time pointsGained)
+# Installation
+`Note: Linux only`
+1. Clone this repo 
+2. rename `database/example.db` to `database/data.db`
+3. Execute `main`