Skip to content

Commit 1427b6f

Browse files
committed
docs: basic information update
1 parent 9669e51 commit 1427b6f

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
* [Getting started](#getting-started)
2222
* [Docker](#docker)
2323
* [Node](#node)
24+
* [Services](#services)
25+
* [Themes](#themes)
26+
* [Icons](#icons)
27+
* [Languages](#multi-language)
2428
* [License](#license)
2529
</details>
2630

@@ -79,6 +83,40 @@ yarn preview
7983

8084
The application will start with a basic configuration, which is located in the `data` folder.
8185

86+
## Services
87+
88+
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.
89+
90+
List of services:
91+
* **[Base](https://mafl.hywax.space/services/base.html)** - The main card of the service. Other services are created on the basis of this service.
92+
93+
## Themes
94+
95+
There are several ready-made themes in `Mafl`. But nothing prevents you from creating your own design themes and sharing them with other users
96+
97+
<img src="https://raw.githubusercontent.com/hywax/mafl/main/docs/public/themes.png" alt="Mafl themes" width="100%"/>
98+
99+
## Icons
100+
101+
Services can have icons. With support for several different icon packs, you can find the perfect thumbnail for any application or service.
102+
103+
Supported types:
104+
* **[Iconify](https://icon-sets.iconify.design/)** - Over 200,000 open source vector icons
105+
* **Emoji** - Any valid emoji can be used as an icon
106+
* **URL** - Pass the URL of any matching image so that it can be found and displayed.
107+
* **Local** - Store custom images locally and reference them by file name
108+
109+
110+
## Multi-language
111+
112+
`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.
113+
114+
Supported Languages:
115+
* 🇬🇧 **English** - `en`
116+
* 🇷🇺 **Russian** - `ru`
117+
118+
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.
119+
82120
## License
83121

84122
This app is open-sourced software licensed under the [MIT license](https://github.com/hywax/mafl/blob/main/LICENSE).

0 commit comments

Comments
 (0)