Make README.md look clean and add docs

Author: lulunac27a

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: docs
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

README.md

@@ -29,7 +29,7 @@ npm run serve
 npm run build
 ```
 
-### Lint code to check for errors and warnings
+### Lints code to check for errors and warnings
 
 ```
 npm run lint

docs/index.md

@@ -0,0 +1,36 @@
+# Vue gamification todo list app with Vuex, SCSS and TypeScript
+
+This application is a todo list with task repetition with level and experience points and it stores to local storage using `vuex-persistedstate`.
+
+## Contents
+
+`src`: Source for Vue, SCSS and TypeScript files.
+`src/components`: Vue components to render as HTML with SCSS style.
+`src/store`: Vuex store and store options.
+
+
+
+## Setup the application
+
+```
+git clone https://github.com/lulunac27a/gamification-todo-list-vue-typescript.git
+npm install
+```
+
+### Serve the application
+
+```
+npm run serve
+```
+
+### Build the application to compile and minify the code
+
+```
+npm run build
+```
+
+### Lints code to check for errors and warnings
+
+```
+npm run lint
+```

mkdocs.yml

@@ -0,0 +1,3 @@
+site_name: Gamification Todo List using Vue and TypeScript
+theme: material
+repo_url: https://github.com/lulunac27a/gamification-todo-list-vue-typescript