Skip to content

Commit

Permalink
chore: Change README
Browse files Browse the repository at this point in the history
NriotHrreion committed Jul 30, 2022
1 parent 661e63b commit 10e0338
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -100,12 +100,10 @@ sudo sysctl fs.inotify.max_user_watches=582222 && sudo sysctl -p

There is a plugin folder `/src/plugins`. Under the folder, there are plugins which are viewers for different kinds of file formats (e.g. *.mp4 *.avi).

It's necessary to explain that the plugins are only used as viewers now. I might add more feature to it in the future.
### Write a Viewer Plugin

Viewer is a page that is shown when the user opens a file. The viewer's page will be shown when the user opens the file format(s) the viewer's option has specified. For example, a video viewer, its page will be shown when the user open a `.mp4` file.

### Write a Viewer Plugin

Firstly, you need to create a new `tsx` file. The name of the file had better end with `ViewerPlugin`.

And a metadata list of the plugin is needed.

0 comments on commit 10e0338

Please sign in to comment.