Skip to content

Commit

Permalink
docs: basic information update
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Jan 5, 2024
1 parent 9669e51 commit 1427b6f
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@
* [Getting started](#getting-started)
* [Docker](#docker)
* [Node](#node)
* [Services](#services)
* [Themes](#themes)
* [Icons](#icons)
* [Languages](#multi-language)
* [License](#license)
</details>

Expand Down Expand Up @@ -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

<img src="https://raw.githubusercontent.com/hywax/mafl/main/docs/public/themes.png" alt="Mafl themes" width="100%"/>

## 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).

0 comments on commit 1427b6f

Please sign in to comment.