Skip to content

Commit

Permalink
Readme: updated with new features
Browse files Browse the repository at this point in the history
  • Loading branch information
warpdesign committed May 14, 2024
1 parent 6485af8 commit 8784b23
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 10 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# File manager written in TypeScript & React
# Cross-platform File manager for Windows, Mac, Linux

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

Expand All @@ -8,15 +8,33 @@

- Split-view window
- Tabs support
- Media File Preview
- Fully keyboard controlled
- Fully localized (French & English available)
- Dark Mode with automatic detection (macOS Mojave)
- Fully localized
- Dark Mode with automatic detection
- Open a terminal from any folder
- Plugin-based filesystem support
- WSL detection on Windows
- WSL integration (Windows)

## Feature tour

### Trully Cross-platform

React-Explorer is available on every major operating systems & architectures:

- Windows x66, AARCH64
- Linux x64, AARCH64
- macOS x64, AARCH64

### Builtin media file preview

Pressing the `space` bar when a file is selected will open the media preview.
If the file format is supported, it will be displayed without needing any additional
library:

![media-preview](./img/media-preview.gif)


### Dark theme automatic detection (macOS Mojave)

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

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

![parent-folders](./img/feature-wsl.jpg)
![wsl-support](./img/feature-wsl.jpg)

## Requirements

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

## Building for local development

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

## Acknowledgments

React-Explorer makes use of the following tools/components:
React-Explorer makes use of the following libraries/components:

- [React](https://reactjs.org)
- [Electron](https://electron.s.org)
Expand Down
Binary file added img/media-preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-explorer",
"version": "4.0.0",
"version": "4.0.0-rc.1",
"description": "Plugin-based file explorer written with React",
"main": "build/main.js",
"build": {
Expand Down

0 comments on commit 8784b23

Please sign in to comment.