Skip to content

Commit

Permalink
docs: add emoji
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Jan 5, 2024
1 parent bfa7793 commit 98f5633
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@
<details>
<summary><b>Table of Contents</b></summary>

* [Features](#features)
* [Getting started](#getting-started)
* [Features](#-features)
* [Getting started](#-getting-started)
* [Docker](#docker)
* [Node](#node)
* [Services](#services)
* [Themes](#themes)
* [Icons](#icons)
* [Languages](#multi-language)
* [License](#license)
* [Services](#-services)
* [Themes](#-themes)
* [Icons](#-icons)
* [Languages](#-multi-language)
* [License](#-license)
</details>

## Features
## 🎯 Features

* πŸ” **Privacy**. All requests to third-party services occur in backend.
* ⚑ **Real-time**. Interactive cards with extra information.
Expand All @@ -41,7 +41,7 @@
* ✨ **Free**. Mafl is completely free and open source.
* πŸ“² **PWA**. Installable application.

## Getting started
## πŸš€ Getting started

### Docker

Expand Down Expand Up @@ -83,20 +83,20 @@ yarn preview

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

## Services
## πŸ“Š 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
## 🎨 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
## πŸ–Ό Icons

Services can have icons. With support for several different icon packs, you can find the perfect thumbnail for any application or service.

Expand All @@ -107,7 +107,7 @@ Supported types:
* **Local** - Store custom images locally and reference them by file name


## Multi-language
## 🌎 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.

Expand All @@ -117,6 +117,6 @@ Supported Languages:

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
## πŸ“„ License

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

0 comments on commit 98f5633

Please sign in to comment.