Skip to content

Commit 8784b23

Browse files
committed
Readme: updated with new features
1 parent 6485af8 commit 8784b23

File tree

4 files changed

+28
-10
lines changed

4 files changed

+28
-10
lines changed

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# File manager written in TypeScript & React
1+
# Cross-platform File manager for Windows, Mac, Linux
22

33
![master Tests](https://github.com/warpdesign/react-explorer/actions/workflows/github-actions-tests.yml/badge.svg?branch=master)
44

@@ -8,15 +8,33 @@
88

99
- Split-view window
1010
- Tabs support
11+
- Media File Preview
1112
- Fully keyboard controlled
12-
- Fully localized (French & English available)
13-
- Dark Mode with automatic detection (macOS Mojave)
13+
- Fully localized
14+
- Dark Mode with automatic detection
1415
- Open a terminal from any folder
1516
- Plugin-based filesystem support
16-
- WSL detection on Windows
17+
- WSL integration (Windows)
1718

1819
## Feature tour
1920

21+
### Trully Cross-platform
22+
23+
React-Explorer is available on every major operating systems & architectures:
24+
25+
- Windows x66, AARCH64
26+
- Linux x64, AARCH64
27+
- macOS x64, AARCH64
28+
29+
### Builtin media file preview
30+
31+
Pressing the `space` bar when a file is selected will open the media preview.
32+
If the file format is supported, it will be displayed without needing any additional
33+
library:
34+
35+
![media-preview](./img/media-preview.gif)
36+
37+
2038
### Dark theme automatic detection (macOS Mojave)
2139

2240
React-Explorer will automatically switch to dark-theme when it's detected:
@@ -45,11 +63,11 @@ By right-clicking on a tab's icon you can quickly get access to the parents of t
4563

4664
React-Explorer will automatically detect and show the list of Linux distributions installed using WSL on Windows:
4765

48-
![parent-folders](./img/feature-wsl.jpg)
66+
![wsl-support](./img/feature-wsl.jpg)
4967

5068
## Requirements
5169

52-
React-Explorer works on any modern Windows, Mac or Linux computer.
70+
React-Explorer works on any modern **Windows**, **Mac** or **Linux** **64bit** computer.
5371

5472
## Building for local development
5573

@@ -147,7 +165,7 @@ As a starting point you may use the `FsGeneric` skeleton.
147165

148166
## Acknowledgments
149167

150-
React-Explorer makes use of the following tools/components:
168+
React-Explorer makes use of the following libraries/components:
151169

152170
- [React](https://reactjs.org)
153171
- [Electron](https://electron.s.org)

img/media-preview.gif

2.52 MB
Loading

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-explorer",
3-
"version": "4.0.0",
3+
"version": "4.0.0-rc.1",
44
"description": "Plugin-based file explorer written with React",
55
"main": "build/main.js",
66
"build": {

0 commit comments

Comments
 (0)