update docs

README.md

@@ -1,20 +1,19 @@
 # Magma Dashboard
-Personal dashboard inspired by flame, highly customizable, lightweight and responsive.
+Personal dashboard that is highly customizable, lightweight and responsive.
 
-![Magma dashboard preview](https://i.imgur.com/XaAvyRC.png)
+![Magma dashboard preview](https://i.imgur.com/ehcCstY.png)
 
 ## Features
-* Lightweight, fast, run with Deno
-* Run as static Html website
-* Support multiple language
-* Highly customizable, you can replace everything you want
+* Lightweight (8-16Mb), fast, build from Go
+* Support multiple languages
+* Support multiple themes
 * Addons support (WIP)
 
 ## How to use
 * Download our [docker-compose.yml](./docker-compose.yml) file
 * Start with `docker-compose up -d`
-* Go to `common/config.yaml` to config your dashboard
-* Go to `common/data.yaml` to edit your bookmarks
+* Go to `data/config.yaml` to config your dashboard
+* Go to `data/data.yaml` to edit your bookmarks
 * See your dashboard at [localhost:7001](http://localhost:7001)
 
 ## Customization

docs/README.md

@@ -1,11 +1,10 @@
 # Magma Dashboard
-Personal dashboard inspired by flame, highly customizable, lightweight and responsive.
+Personal dashboard that is highly customizable, lightweight and responsive.
 
 ![Magma dashboard preview](https://i.imgur.com/XaAvyRC.png)
 
 ## Features
-* Light weight, fast, run with Deno
-* Run as static Html website
-* Support multiple language
-* Highly customizable, you can replace everything you want
+* Lightweight (8-16Mb), fast, build from Go
+* Support multiple languages
+* Support multiple themes
 * Addons support (WIP)

docs/config.md

@@ -1,33 +1,34 @@
 # Configuration
 
-Your configuration is in `/public/config.json` like this:
+Your configuration is in `/data/config.yaml` like this:
 
 ```
-{
-    "website": {
-        "theme": "flame",
-        "title": "Magma Dashboard",
-        "description": "",
-        "language": "en",
-        "localization": "en-us",
-        "useMetric": true
-    },
-    "addons": []
-}
+website:
+  theme: "flame"
+  title: "Magma Dashboard"
+  description: ""
+  language: "en"
+  localization: "en-US"
+  useMetric: true
+openweathermap:
+  apiKey:
+  lon:
+  lat:
+addons:
 ```
 
-| Field | Type | Meaning |
-|-|-|-|
-| website | Object | Website configuration |
-| addons | Array | List of addon to run. E.g: `["addon-1", "addon-2"]` |
+| Field   | Type   | Meaning                                             |
+| ------- | ------ | --------------------------------------------------- |
+| website | Object | Website configuration                               |
+| addons  | Array  | List of addon to run. E.g: `["addon-1", "addon-2"]` |
 
 Website configuration:
 
-| Field | Type | Meaning |
-|-|-|-|
-| theme | string | Name of your selected theme, default is `flame` |
-| title | string | Title of your website, will be inject into `<title></title>` |
-| description | string | Description of your website, will be inject into `<meta name="description" content="" />` |
-| language | string | Selected language file in `/private/languages` without `.json` extension. |
-| localization | string | Localization that will be use to show date/time |
-| useMetric | boolean | Set to `true` to use `°C`, `false` to use `°F` |
+| Field        | Type    | Meaning                                                                                   |
+| ------------ | ------- | ----------------------------------------------------------------------------------------- |
+| theme        | string  | Name of your selected theme, default is `flame`                                           |
+| title        | string  | Title of your website, will be inject into `<title></title>`                              |
+| description  | string  | Description of your website, will be inject into `<meta name="description" content="" />` |
+| language     | string  | Selected language file in `/languages` without `.yaml` extension.                         |
+| localization | string  | Localization that will be use to show date/time                                           |
+| useMetric    | boolean | Set to `true` to use `°C`, `false` to use `°F`                                            |

docs/customization/css.md

@@ -2,7 +2,7 @@
 
 ## Changing background, color pallete
 
-In order to change those default values, edit `/common/css/core.css`.
+In order to change those default values, edit `/data/css/core.css`.
 
 ```
 :root {
@@ -13,12 +13,12 @@ In order to change those default values, edit `/common/css/core.css`.
 }
 ```
 
-| Key | Required | Meaning |
-|-|-|-|
-| --bgColor | Yes | Background color of `<body>`, also use as overlay color of background image. |
-| --bgImage | Yes | An image place on top of `<body>` background color, with opacite 60%, scale 1.1, margin-top: -5% |
-| --accentColor | Yes | Accent color use in highlight place like weather icon, group title, ... |
-| --foreground | Yes | Default text color. |
+| Key           | Required | Meaning                                                                                          |
+| ------------- | -------- | ------------------------------------------------------------------------------------------------ |
+| --bgColor     | Yes      | Background color of `<body>`, also use as overlay color of background image.                     |
+| --bgImage     | Yes      | An image place on top of `<body>` background color, with opacite 60%, scale 1.1, margin-top: -5% |
+| --accentColor | Yes      | Accent color use in highlight place like weather icon, group title, ...                          |
+| --foreground  | Yes      | Default text color.                                                                              |
 
 ## Custom CSS styles
 

docs/getting-started.md

@@ -20,7 +20,15 @@ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
 Create [docker-compose.yml](https://github.com/help-14/magma/blob/main/docker-compose.yml) or download it from Github:
 
 ```
-version "3.0"
+services:
+  magma:
+    container_name: magma
+    image: help14/magma
+    restart: unless-stopped
+    volumes:
+      - ./data/:/app/data
+    ports:
+      - '7001:7001'
 ```
 
 Start the container: