Skip to content

add usage guide in readme #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add usage guide in readme #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,10 @@ occ config:app:set dashboard layout --value=welcome,recommendations,spreed,mail,

### Screenshot

![Welcome widget example](img/screenshot1.jpg)
![Welcome widget example](img/screenshot1.jpg)

### General Usage Guide

1. The markdown file should only be created from the Text app for proper support of links and images
2. Manually added links should ideally be absolute links with file IDs for files/folders (eg. `http://cloud.example.com/index.php/f/123`)
3. Images would be displayed only if added through the image icon in the Text app and not through relative path or file ID links