Add fleshing out index.md content & Add github action to build websit…

…e docs

.github/workflows/publish-docs.yml

@@ -0,0 +1,65 @@
+name: Publish docs
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy_docs:
+    runs-on: macos-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: 21
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Install dependencies
+        run: |
+          brew install cairo freetype libffi libjpeg libpng zlib
+          python3 -m pip install --upgrade pip
+          python3 -m pip install mkdocs mkdocs-material mkdocs-video "mkdocs-material[imaging]"
+
+      - name: Build site
+        run: mkdocs build
+        env:
+          DYLD_FALLBACK_LIBRARY_PATH: /opt/homebrew/lib
+
+      - uses: gradle/gradle-build-action@v3
+
+      - run: |
+          ./gradlew --no-configuration-cache \
+              :dokkaHtmlMultiModule \
+
+      - name: Copy Dokka output to site
+        run: cp -r build/dokka/htmlMultiModule/ site/api/
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'site'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,12 +1,11 @@
-# k-location
+# KLocation
 
-A Kotlin multi-platform location tracker with support for providing your own location provider
-with support for compose multi-platform.
+Checkout the [documentation](https://addhen.github.io/klocation/) for more information.
 
 ## License
 
 ```
-Copyright 2024, Addhen Ltd and the k-location project contributors
+Copyright 2024, Addhen Ltd and the KLocation project contributors
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

docs/index.md

@@ -0,0 +1,29 @@
+KLocation is a Kotlin Multiplatform library for retrieving device location data, offering seamless
+integration with Compose Multiplatform projects.
+
+<!--![type:video](./media/android.mp4) -->
+
+Supports the following platforms:
+
+| Platform      | Supported        |
+|---------------|------------------|
+| Android       | ✅               |
+| iOS           | ✅               |
+
+## License
+
+```
+Copyright 2024 Addhen Ltd and the KLocation project contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```