Skip to content

Commit

Permalink
docs(preview): content presentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Jan 2, 2024
1 parent 0123b36 commit 22ec2a3
Showing 1 changed file with 28 additions and 19 deletions.
47 changes: 28 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,38 @@
# Mafl
<h1 align="center">Mafl</h1>
<p align="center">
<i>Mafl is an intuitive service for organizing your homepage. Customize Mafl to your individual needs and work even more efficiently!</i>
<br/><br/>
<img width="130" src="https://raw.githubusercontent.com/hywax/mafl/main/docs/public/logotype.svg" />
<br/><br/>
<b><a href="https://github.com/hywax/mafl">GitHub</a>
<br/><br/>
<a href="https://github.com/hywax/mafl/blob/main/CHANGELOG.md">
<img src="https://img.shields.io/github/package-json/v/hywax/mafl?logo=hackthebox&color=609966&logoColor=fff" alt="Current Version">
</a>
<a target="_blank" href="https://github.com/hywax/mafl">
<img src="https://img.shields.io/github/last-commit/hywax/mafl?logo=github&color=609966&logoColor=fff" />
</a>
<a target="_blank" href="https://hub.docker.com/r/hywax/mafl">
<img src="https://img.shields.io/docker/pulls/hywax/mafl?logo=docker&color=609966&logoColor=fff" />
</a>
<a href="https://github.com/hywax/mafl/blob/main/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-609966?logo=opensourceinitiative&logoColor=fff" alt="License MIT">
</a>
<br/><br/>
<img src="https://raw.githubusercontent.com/hywax/mafl/main/docs/public/cover.png" width="100%" />
</p>

<details>
<summary><b>Table of Contents</b></summary>

Mafl is an intuitive service for organizing your homepage. Customize Mafl to your individual needs and work even more efficiently!

## Table of Contents
* [Features](#features)
* [Getting started](#getting-started)
* [Docker](#docker)
* [Node](#node)
* [Proxmox](#proxmox)
* [Cloud Providers](#cloud-providers)
* [Roadmap](#roadmap)
* [License](#roadmap)
* [License](#license)
</details>

## Features

Expand Down Expand Up @@ -60,19 +82,6 @@ services:

...

## Roadmap

* [ ] Creating the basic application skeleton
* [ ] Publishing to docker
* [ ] Dynamic services
* [ ] Keyboard navigation
* [ ] Custom themes
* [ ] Drag & drop
* [ ] Search
* [ ] Localization
* [ ] Multiple pages
* [ ] Docker integration

## License

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

0 comments on commit 22ec2a3

Please sign in to comment.