Skip to content

Commit 2326826

Browse files
Trim README callouts to essential sections
1 parent 1fab48e commit 2326826

1 file changed

Lines changed: 0 additions & 45 deletions

File tree

README.md

Lines changed: 0 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,16 @@ 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.
20-
2118
- Keep large Docker/VM setups readable with folder grouping in Docker, VMs, and Dashboard
2219
- Recover faster with automatic backups, snapshot compare, and one-click restore
2320
- Import safely with preview diff and selective apply before making changes
2421
- Reduce manual work using regex/label-based assignment rules
2522
- Manage everything from a modern settings flow that works on desktop and mobile
2623

2724
## Requirements
28-
> [!IMPORTANT]
29-
> Unraid `7.0.0+` is required.
30-
3125
- Unraid `7.0.0+`
3226

3327
## Install
34-
> [!NOTE]
35-
> Install from Unraid Plugins UI or with the CLI command below.
36-
3728
Unraid UI (`Plugins -> Install Plugin`) or CLI:
3829

3930
```bash
@@ -69,9 +60,6 @@ plugin remove folderview.plus
6960
```
7061

7162
## Feature Highlights
72-
> [!TIP]
73-
> High-level capabilities across organization, automation, safer operations, and UX.
74-
7563
### Organization and Control
7664

7765
- Folder views for Docker, VMs, and Dashboard
@@ -106,29 +94,20 @@ plugin remove folderview.plus
10694
- Modern browser support (Chrome, Edge, Firefox, Safari)
10795

10896
## Quick Start
109-
> [!NOTE]
110-
> This is the fastest path to a working setup.
111-
11297
1. Open `Settings -> FolderView Plus`.
11398
2. Create folders in Docker and/or VM sections.
11499
3. Choose sort mode and view options.
115100
4. Save.
116101
5. Confirm folder groups in Docker/VM tabs.
117102

118103
## Rules Quick Guide
119-
> [!IMPORTANT]
120-
> Rule order is priority-based from top to bottom; exclude rules take precedence.
121-
122104
1. Switch to `Advanced`.
123105
2. Open `Auto-assignment rules`.
124106
3. Choose folder, rule kind, and action (`Include`/`Exclude`).
125107
4. Add rule, then save.
126108
5. Use `Test rule priority` or `Simulate all items` to validate behavior.
127109

128110
## Import, Export, and Backups
129-
> [!WARNING]
130-
> Best practice: export first, then import with preview diff and backup safety.
131-
132111
Export files:
133112

134113
- Docker: `FolderView Plus Export.json`
@@ -149,17 +128,11 @@ Recommended import flow:
149128
5. Use `Restore latest backup` if needed.
150129

151130
## Security and Reliability
152-
> [!CAUTION]
153-
> Keep these controls enabled for safer production usage.
154-
155131
- Request token and guarded endpoint protections
156132
- Safer dynamic rendering to reduce XSS risk
157133
- Automated regression checks (including mobile and release guards)
158134

159135
## Browser Support
160-
> [!NOTE]
161-
> Validated on current major browser versions.
162-
163136
Supported current major browsers:
164137

165138
- Chrome
@@ -173,26 +146,17 @@ Not supported:
173146
- Legacy Edge (EdgeHTML)
174147

175148
## Paths
176-
> [!NOTE]
177-
> Primary runtime and customization paths.
178-
179149
- Config root: `/boot/config/plugins/folderview.plus`
180150
- Custom CSS: `/boot/config/plugins/folderview.plus/styles`
181151
- Custom JS: `/boot/config/plugins/folderview.plus/scripts`
182152
- Third-party icons: `/usr/local/emhttp/plugins/folderview.plus/images/third-party-icons`
183153
- User-uploaded icons: `/usr/local/emhttp/plugins/folderview.plus/images/custom`
184154

185155
## Included Icon Pack Credits
186-
> [!TIP]
187-
> Bundled icon sources used for built-in icon management.
188-
189156
- https://github.com/sameerasw/folder-icons
190157
- https://github.com/hernandito/unRAID-Docker-Folder-Animated-Icons---Alternate-Colors
191158

192159
## Development
193-
> [!IMPORTANT]
194-
> Use the scripts below before publishing or release workflows.
195-
196160
- Runtime source: `src/folderview.plus/`
197161
- Manifest: `folderview.plus.plg`
198162
- Archives: `archive/`
@@ -216,9 +180,6 @@ node --test tests/*.mjs
216180
```
217181

218182
## Support
219-
> [!NOTE]
220-
> Use GitHub Issues for bug reports and feature requests.
221-
222183
- Issues: https://github.com/alexphillips-dev/FolderView-Plus/issues
223184

224185
## Sponsor
@@ -227,14 +188,8 @@ node --test tests/*.mjs
227188
> https://buymeacoffee.com/alexphillipsdev
228189
229190
## Credits
230-
> [!NOTE]
231-
> Project foundation and icon pack acknowledgements.
232-
233191
- [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.
234192
- [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.
235193

236194
## License
237-
> [!NOTE]
238-
> Distributed under the MIT license.
239-
240195
See `LICENSE.md`.

0 commit comments

Comments
 (0)