Skip to content

Commit 3299d62

Browse files
ashuvssutashuvssut
committed
update Readme
1 parent b79d412 commit 3299d62

File tree

2 files changed

+66
-4
lines changed

2 files changed

+66
-4
lines changed

‎README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
# fs-prober
2-
fs-prober is a browser-friendly NPM package for extracting file and folder structures from user-selected files or directories.
1+
# FS Prober
2+
3+
![FS Prober](./docs/static/img/social-card.png)
4+
5+
6+
The **FS Prober** package is a browser-friendly NPM package for extracting file and folder structures from user-selected files or directories.
7+
8+
# What does it do?
9+
10+
The **FS Prober** package extends [react-dropzone](https://react-dropzone.js.org/) by adding support for *detecting empty folders*, including deeply nested ones. It maintains full compatibility with `react-dropzone`, adhering to the same props and return types while enhancing its functionality.
11+
12+
While `react-dropzone` provides a simple React hook for creating an HTML5-compliant drag-and-drop zone, it has limitations in detecting empty folders, as noted in this [GitHub issue](https://github.com/react-dropzone/react-dropzone/issues/986#issuecomment-687603291).
13+
14+
FS Prober uses standard file system APIs, ensuring that even empty folders within a directory structure are correctly detected. It is tested with the latest versions of Chrome, Firefox, Edge, and Safari and supports both the [File and Directory Entries API](https://developer.mozilla.org/en-US/docs/Web/API/File_and_Directory_Entries_API) and the [WICG File System Access API](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API).
15+
16+
> [!NOTE]
17+
> File and Directory Entries API is available in all latest browsers. But the WICG File System Access API might not be available in all browsers yet.
18+
> FS Prober uses File and Directory Entries API by default.
19+
20+
The FS Prober package extends the functionality of [`useDropzone`](https://react-dropzone.js.org/#usage) by using standard File System APIs, allowing it to detect even deeply nested empty folders.
21+
22+
## Installation
23+
24+
```sh
25+
# NPM
26+
npm install @knide/fs-prober
27+
28+
# Yarn
29+
yarn add @knide/fs-prober
30+
```
31+
32+
## Usage
33+
34+
Check out the [documentation](https://stacknide.github.io/fs-prober/docs/usage) for detailed usage instructions.

‎package/README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
1-
# fs-prober
1+
# FS Prober
22

3-
fs-prober is a browser-friendly NPM package for extracting file and folder structures from user-selected files or directories.
3+
![FS Prober](./../docs/static/img/social-card.png)
4+
5+
The **FS Prober** package is a browser-friendly NPM package for extracting file and folder structures from user-selected files or directories.
6+
7+
# What does it do?
8+
9+
The **FS Prober** package extends [react-dropzone](https://react-dropzone.js.org/) by adding support for *detecting empty folders*, including deeply nested ones. It maintains full compatibility with `react-dropzone`, adhering to the same props and return types while enhancing its functionality.
10+
11+
While `react-dropzone` provides a simple React hook for creating an HTML5-compliant drag-and-drop zone, it has limitations in detecting empty folders, as noted in this [GitHub issue](https://github.com/react-dropzone/react-dropzone/issues/986#issuecomment-687603291).
12+
13+
FS Prober uses standard file system APIs, ensuring that even empty folders within a directory structure are correctly detected. It is tested with the latest versions of Chrome, Firefox, Edge, and Safari and supports both the [File and Directory Entries API](https://developer.mozilla.org/en-US/docs/Web/API/File_and_Directory_Entries_API) and the [WICG File System Access API](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API).
14+
15+
> [!NOTE]
16+
> File and Directory Entries API is available in all latest browsers. But the WICG File System Access API might not be available in all browsers yet.
17+
> FS Prober uses File and Directory Entries API by default.
18+
19+
The FS Prober package extends the functionality of [`useDropzone`](https://react-dropzone.js.org/#usage) by using standard File System APIs, allowing it to detect even deeply nested empty folders.
20+
21+
## Installation
22+
23+
```sh
24+
# NPM
25+
npm install @knide/fs-prober
26+
27+
# Yarn
28+
yarn add @knide/fs-prober
29+
```
30+
31+
## Usage
32+
33+
Check out the [documentation](https://stacknide.github.io/fs-prober/docs/usage) for detailed usage instructions.

0 commit comments

Comments
 (0)