From 831d2d81fc526272cf540b19044abb943122a8f0 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Thu, 13 Aug 2020 16:51:41 +0200 Subject: [PATCH] add documentation --- README.md | 16 ++++++++++------ appinfo/info.xml | 5 +++-- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a6d2fb9..7736e27 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ 🤙 Nextcloud app / Side menu 🎨 =============================== -Side menu allows you to modify the position of the main menu by creating a panel on the left of the interface. +Side menu allows you to modify the position of the main menu by creating a panel on the left of the interface or with a big menu on the top. +You can also define apps that must be displayed in the top menu. Fully customisable. + This application is rather suitable for instances that activate a lot of applications. Comptatible with AppOrder. @@ -38,17 +40,19 @@ If you are a developer: * go to `apps/` and clone your repository * go to `apps/side_menu` and run `npm install` -Build javascripts using `webpack --config ./webpack.js` (add `-w` to build them in real time). +Build javascripts using `npm run build` (or `npm run watch` to build them in real time). Then commit and create a pull request. -Preview -------- +Previews +-------- ![](https://upload.deblan.org/u/2020-03/5e81b219.jpg) ![](https://upload.deblan.org/u/2020-03/5e7fab2b.jpg) -![](https://upload.deblan.org/u/2020-05/5eb6b76e.png) +![](https://upload.deblan.org/u/2020-08/5f3552b8.png) -![](https://upload.deblan.org/u/2020-05/5eb6b78a.png) +![](https://upload.deblan.org/u/2020-08/5f3551d1.png) + +![](https://upload.deblan.org/u/2020-08/5f3551f0.png) diff --git a/appinfo/info.xml b/appinfo/info.xml index b005569..c376bbe 100644 --- a/appinfo/info.xml +++ b/appinfo/info.xml @@ -23,8 +23,9 @@ You can report a bug or request a feature by opening an issue. https://gitnet.fr/deblan/side_menu https://upload.deblan.org/u/2020-03/5e81b219.jpg https://upload.deblan.org/u/2020-03/5e7fab2b.jpg - https://upload.deblan.org/u/2020-05/5eb6b76e.png - https://upload.deblan.org/u/2020-05/5eb6b78a.png + https://upload.deblan.org/u/2020-08/5f3552b8.png + https://upload.deblan.org/u/2020-08/5f3551d1.png + https://upload.deblan.org/u/2020-08/5f3551f0.png