documentation (README): update README

This commit is contained in:
Mickael KERJEAN 2018-05-15 05:17:27 +10:00
parent 8bb085b992
commit 6462eaa244
31 changed files with 24 additions and 5 deletions

BIN
.assets/img/navigation.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 470 KiB

BIN
.assets/img/orgmode.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB

3
.assets/raw/Makefile Normal file
View file

@ -0,0 +1,3 @@
all:
convert -delay 100 -loop 0 navigation_*.png navigation.gif
convert -delay 100 -loop 0 orgmode_*.png orgmode.gif

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 179 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 233 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

View file

@ -12,24 +12,40 @@
</p>
# Features
- Manage your files directly from your browser
- Manage your files from a browser
- User friendly
- Org mode friendly ([documentation](https://github.com/mickael-kerjean/nuage/wiki/Org-Mode))
- Mobile friendly
- Customisable ([documentation](https://github.com/mickael-kerjean/nuage/wiki/Customisation))
- Super fast
- Works offline
- Upload files and folders
- Works great on mobile
- Multiple cloud providers and protocols, easily extensible
- Audio player
- Video player
- Image viewer
- Emacs keybindings `;)`
- Frequently access folders are pin to the homepage for quick access
- Quick access: frequently access folders are pin to the homepage
- Stateless
- Emacs keybindings `;)`
# Screenshots
<p align="center">
<a href="http://nuage.kerjean.me">
<img src="https://raw.githubusercontent.com/mickael-kerjean/nuage/master/.assets/img/navigation.gif" alt="user experience on navigation" />
Navigating in Nuage
</a>
</p>
<p align="center">
<a href="https://github.com/mickael-kerjean/nuage/wiki/Org-Mode">
<img src="https://raw.githubusercontent.com/mickael-kerjean/nuage/master/.assets/img/navigation.gif" alt="org mode" />
Bringing org mode everywhere
</a>
</p>
# Getting started - Installation
Nuage can be used in different ways:
Nuage can be used in different settings:
- Selfhosting ([documentation](https://github.com/mickael-kerjean/nuage/wiki/Installation:-Selhosting)): install it somewhere you have full control (with docker, without docker, on a server or even android)
- Paas ([documentation](https://github.com/mickael-kerjean/nuage/wiki/Installation:-PaaS)): deployment on Heroku or AWS Lambda
- Saas ([documentation](https://github.com/mickael-kerjean/nuage/wiki/Installation:-SaaS)): official instance or private instance fully managed