From 3bb86c6198c139332a739be16f299de5ef5cb5aa Mon Sep 17 00:00:00 2001 From: ruihildt Date: Mon, 29 Jul 2019 18:37:09 +0200 Subject: [PATCH] Update readme intro and formatting --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7c8f310..e61ff41 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -Sleep Tracker allows Users to create an account and track their sleep and mood every day in order to improve their sleep. +Sleep Tracker helps Users track their sleep and mood every day. +It gives Users a better idea of their sleep pattern and improve their health. After one month, Sleep Tracker will give recommendation of optimal sleep duration. -Sleep Track aims to help Users improve their sleep pattern and global health. ## Target Audience Sleep Tracker is intended for anyone interested in improving their sleep and health. @@ -26,23 +26,23 @@ Sleep Tracker is intended for anyone interested in improving their sleep and hea | username | string | required | | password | string | required | -### Sleep Sessions | `sessions` +### Sleep Sessions `sessions` | field | data type | metadata | | :------------ | :--------------- | :-------------------------------------------------- | | id | unsigned integer | primary key, auto-increments, generated by database | -| user_id | unsigned integer | foreign key referencing users.id, required | +| user_id | unsigned integer | foreign key referencing `users.id`, required | | bed_time | unsigned integer | timestamp with date, required | | wake_time | unsigned integer | timestamp with date, required | | bed_tiredness | unsigned integer | between 1-5, | | wake_mood | unsigned integer | between 1-5, | | day_mood | unsigned integer | between 1-5, | -### Average Mood per Sleep Session | `moods` +### Average Mood per Sleep Session `moods` | field | data type | metadata | | :------------- | :--------------- | :--------------------------------------------------- | | id | unsigned integer | primary key, auto-increments, generated by database | -| session_date | unsigned integer | foreign key referencing sessions.wake_time | +| session_date | unsigned integer | foreign key referencing `sessions.wake_time` | | sleep_duration | unsigned integer | | | average_mood | float | average of bed_tiredness/wake_mood/day_mood |