add documentation

This commit is contained in:
Simon Vieille 2020-08-13 16:51:41 +02:00
parent c6a43f755d
commit 831d2d81fc
Signed by: deblan
GPG key ID: 03383D15A1D31745
2 changed files with 13 additions and 8 deletions

View file

@ -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)

View file

@ -23,8 +23,9 @@ You can report a bug or request a feature by opening an issue.
<repository type="git">https://gitnet.fr/deblan/side_menu</repository>
<screenshot>https://upload.deblan.org/u/2020-03/5e81b219.jpg</screenshot>
<screenshot>https://upload.deblan.org/u/2020-03/5e7fab2b.jpg</screenshot>
<screenshot>https://upload.deblan.org/u/2020-05/5eb6b76e.png</screenshot>
<screenshot>https://upload.deblan.org/u/2020-05/5eb6b78a.png</screenshot>
<screenshot>https://upload.deblan.org/u/2020-08/5f3552b8.png</screenshot>
<screenshot>https://upload.deblan.org/u/2020-08/5f3551d1.png</screenshot>
<screenshot>https://upload.deblan.org/u/2020-08/5f3551f0.png</screenshot>
<dependencies>
<nextcloud min-version="18" max-version="19"/>
</dependencies>