Skip to content

Commit

Permalink
docs: describe available features
Browse files Browse the repository at this point in the history
  • Loading branch information
herteleo committed Oct 25, 2022
1 parent eee008e commit cf23755
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,30 @@

Open a local folder and explore your files inside the browser. Your files stay private and won't be uploaded anywhere.

## Features
## Scope

- Explore your local files inside the browser.
- Play web-ready audio and video files.
- Browse and present your images.
- Display parsed Markdown files.
- Inspect text documents with syntax highlighting for several languages.
- Inspect text based documents with syntax highlighting for several languages.
- View PDF files.

## Features

- Install Peekaboo as PWA. It works offline too.
- Add a `README.md` file to display its contents above the listed directory entries.
- Filter current directory entries by search term.
- Filter files and folders in current directory by tag. Add tags (comma separated) in square brackets at the end of the file or folder name. Examples:
```
Wallpapers [Dark, Space]
Wallpapers [Abstract, Dark]
IMG001 [2021, Berlin].jpg
IMG002 [2022, New York].jpg
```
- Place an image file named like the folder to define a permanent cover/thumbnail. Example:
- Folder name: `Wallpapers`
- Image inside folder: `Wallpapers.jpg`

---

Expand Down

0 comments on commit cf23755

Please sign in to comment.