Skip to content

Commit 1fab48e

Browse files
Restructure README support and add section alert styling
1 parent b73d33b commit 1fab48e

1 file changed

Lines changed: 37 additions & 5 deletions

File tree

README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ FolderView Plus gives Unraid a cleaner, folder-first way to manage Docker contai
1515
It is built for real libraries: easier organization, safer imports, faster recovery, and better day-to-day control.
1616

1717
## Why Install This
18+
> [!TIP]
19+
> Built for large Docker/VM libraries with safer import, backup, and organization workflows.
1820
1921
- Keep large Docker/VM setups readable with folder grouping in Docker, VMs, and Dashboard
2022
- Recover faster with automatic backups, snapshot compare, and one-click restore
@@ -23,10 +25,14 @@ It is built for real libraries: easier organization, safer imports, faster recov
2325
- Manage everything from a modern settings flow that works on desktop and mobile
2426

2527
## Requirements
28+
> [!IMPORTANT]
29+
> Unraid `7.0.0+` is required.
2630
2731
- Unraid `7.0.0+`
2832

2933
## Install
34+
> [!NOTE]
35+
> Install from Unraid Plugins UI or with the CLI command below.
3036
3137
Unraid UI (`Plugins -> Install Plugin`) or CLI:
3238

@@ -35,6 +41,8 @@ plugin install https://raw.githubusercontent.com/alexphillips-dev/FolderView-Plu
3541
```
3642

3743
## Update
44+
> [!WARNING]
45+
> If update detection is cached, use a one-time commit URL install, then return to `main` updates.
3846
3947
- Preferred: `Plugins -> Check for Updates`
4048
- Manual: rerun the same `plugin install` command
@@ -53,12 +61,16 @@ Version format:
5361
- `UU` is zero-padded for reliable Unraid ordering
5462

5563
## Uninstall
64+
> [!CAUTION]
65+
> Removing the plugin deletes its plugin-managed config directory.
5666
5767
```bash
5868
plugin remove folderview.plus
5969
```
6070

6171
## Feature Highlights
72+
> [!TIP]
73+
> High-level capabilities across organization, automation, safer operations, and UX.
6274
6375
### Organization and Control
6476

@@ -94,6 +106,8 @@ plugin remove folderview.plus
94106
- Modern browser support (Chrome, Edge, Firefox, Safari)
95107

96108
## Quick Start
109+
> [!NOTE]
110+
> This is the fastest path to a working setup.
97111
98112
1. Open `Settings -> FolderView Plus`.
99113
2. Create folders in Docker and/or VM sections.
@@ -102,16 +116,18 @@ plugin remove folderview.plus
102116
5. Confirm folder groups in Docker/VM tabs.
103117

104118
## Rules Quick Guide
119+
> [!IMPORTANT]
120+
> Rule order is priority-based from top to bottom; exclude rules take precedence.
105121
106122
1. Switch to `Advanced`.
107123
2. Open `Auto-assignment rules`.
108124
3. Choose folder, rule kind, and action (`Include`/`Exclude`).
109125
4. Add rule, then save.
110126
5. Use `Test rule priority` or `Simulate all items` to validate behavior.
111127

112-
Rule order is priority-based (top to bottom). Exclude rules block assignment.
113-
114128
## Import, Export, and Backups
129+
> [!WARNING]
130+
> Best practice: export first, then import with preview diff and backup safety.
115131
116132
Export files:
117133

@@ -133,12 +149,16 @@ Recommended import flow:
133149
5. Use `Restore latest backup` if needed.
134150

135151
## Security and Reliability
152+
> [!CAUTION]
153+
> Keep these controls enabled for safer production usage.
136154
137155
- Request token and guarded endpoint protections
138156
- Safer dynamic rendering to reduce XSS risk
139157
- Automated regression checks (including mobile and release guards)
140158

141159
## Browser Support
160+
> [!NOTE]
161+
> Validated on current major browser versions.
142162
143163
Supported current major browsers:
144164

@@ -153,6 +173,8 @@ Not supported:
153173
- Legacy Edge (EdgeHTML)
154174

155175
## Paths
176+
> [!NOTE]
177+
> Primary runtime and customization paths.
156178
157179
- Config root: `/boot/config/plugins/folderview.plus`
158180
- Custom CSS: `/boot/config/plugins/folderview.plus/styles`
@@ -161,11 +183,15 @@ Not supported:
161183
- User-uploaded icons: `/usr/local/emhttp/plugins/folderview.plus/images/custom`
162184

163185
## Included Icon Pack Credits
186+
> [!TIP]
187+
> Bundled icon sources used for built-in icon management.
164188
165189
- https://github.com/sameerasw/folder-icons
166190
- https://github.com/hernandito/unRAID-Docker-Folder-Animated-Icons---Alternate-Colors
167191

168192
## Development
193+
> [!IMPORTANT]
194+
> Use the scripts below before publishing or release workflows.
169195
170196
- Runtime source: `src/folderview.plus/`
171197
- Manifest: `folderview.plus.plg`
@@ -190,19 +216,25 @@ node --test tests/*.mjs
190216
```
191217

192218
## Support
219+
> [!NOTE]
220+
> Use GitHub Issues for bug reports and feature requests.
193221
194222
- Issues: https://github.com/alexphillips-dev/FolderView-Plus/issues
195223

224+
## Sponsor
196225
> [!TIP]
197-
> **Need help or want to support the project?**
198-
> - Open an issue: https://github.com/alexphillips-dev/FolderView-Plus/issues
199-
> - Sponsor development: https://buymeacoffee.com/alexphillipsdev
226+
> If the plugin helps you, support ongoing development here:
227+
> https://buymeacoffee.com/alexphillipsdev
200228
201229
## Credits
230+
> [!NOTE]
231+
> Project foundation and icon pack acknowledgements.
202232
203233
- [chodeus](https://github.com/chodeus/folder.view3) - FolderView Plus is built on the strong foundation of folder.view3. Thank you for the original architecture and groundwork.
204234
- [sameerasw](https://github.com/sameerasw/folder-icons) and [hernandito](https://github.com/hernandito/unRAID-Docker-Folder-Animated-Icons---Alternate-Colors) - Thank you for creating and sharing icon packs that improve local icon workflows.
205235

206236
## License
237+
> [!NOTE]
238+
> Distributed under the MIT license.
207239
208240
See `LICENSE.md`.

0 commit comments

Comments
 (0)