Skip to content

Commit 29f6591

Browse files
committed
Update docs
1 parent 2e7f41a commit 29f6591

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,19 @@ in the comments. If no config file is found in **app/Config** the library will u
5050
## Usage
5151

5252
Default routes:
53-
* **files/index** - Shows all files; the controller will check `mayManage()` to determine if files are read-only or editable
54-
* **files/manage** - Show all files; files are editable
55-
* **files/user** - Shows files for a single user; if no user ID is supplied it defaults to the current logged in user; files are editable
56-
57-
Additional views:
58-
* **Views/files/cards/select** - Can be used to create selectable files, say as part of a form
59-
* **Views/files/list/select** - Can be used to create selectable files, say as part of a form
60-
* **Views/files/dropzone/config** - Default config for Dropzone;
53+
* **files/index** - If user is allowed `mayList()` then shows all files, otherwise tries to fall back to the current logged in user
54+
* **files/user** - Shows files for a single user; if no user ID is supplied it defaults to the current logged in user
55+
56+
Available formats:
57+
* **?format=cards** - Default view with thumbnail on responsive layout
58+
* **?format=list** - An efficient list of files in table format
59+
* **?format=select** - Can be used to create selectable files, e.g. as part of a form
60+
61+
## Access control
62+
63+
This library uses **Tatter\Permits** to control access to files, both generally (list, create)
64+
and specifically per user or group. The super-permit `mayAdmin()` can be added to a user or
65+
group for global file access.
66+
67+
By default the **files/** routes are available as soon as the module is installed. In most
68+
cases you will want to use Route Filters to restrict some or all of the routes.

0 commit comments

Comments
 (0)