From 1427b6f690717aabce6ede8284d65e91a0c33746 Mon Sep 17 00:00:00 2001 From: hywax Date: Fri, 5 Jan 2024 21:30:25 +0500 Subject: [PATCH] docs: basic information update --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 10d459e..ea5fe0e 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,10 @@ * [Getting started](#getting-started) * [Docker](#docker) * [Node](#node) +* [Services](#services) +* [Themes](#themes) +* [Icons](#icons) +* [Languages](#multi-language) * [License](#license) @@ -79,6 +83,40 @@ yarn preview The application will start with a basic configuration, which is located in the `data` folder. +## Services + +The basic concept of `Mafl` is to create not just a homepage, but to create an interactive homepage page. You can combine different services with each other. You can combine different services to create the perfect customized homepage for you. + +List of services: +* **[Base](https://mafl.hywax.space/services/base.html)** - The main card of the service. Other services are created on the basis of this service. + +## Themes + +There are several ready-made themes in `Mafl`. But nothing prevents you from creating your own design themes and sharing them with other users + +Mafl themes + +## Icons + +Services can have icons. With support for several different icon packs, you can find the perfect thumbnail for any application or service. + +Supported types: +* **[Iconify](https://icon-sets.iconify.design/)** - Over 200,000 open source vector icons +* **Emoji** - Any valid emoji can be used as an icon +* **URL** - Pass the URL of any matching image so that it can be found and displayed. +* **Local** - Store custom images locally and reference them by file name + + +## Multi-language + +`Mafl` supports multiple languages and locales. The app should automatically detect your language and set it in the settings. If not, set it in `config.yml` with the `lang` property. + +Supported Languages: +* 🇬🇧 **English** - `en` +* 🇷🇺 **Russian** - `ru` + +If you haven't found your language, it can easily be added! Use the instructions in the section [contributing](https://mafl.hywax.space/community/contributing.html) on docs. + ## License This app is open-sourced software licensed under the [MIT license](https://github.com/hywax/mafl/blob/main/LICENSE).