Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oeway committed Oct 19, 2023
1 parent d788420 commit 8ab7d4e
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In this project, we use elFinder as a file manager for [ImJoy](https://imjoy.io)

You can go to https://jupyter.imjoy.io/, start a notebook and run the following code to open the file manager:

Show the file manager:
Show the file manager as an ImJoy plugin:
```python
from imjoy_rpc import api
async def setup():
Expand Down Expand Up @@ -43,6 +43,7 @@ api.export({"setup": setup})

![Screenshot for elfinder dialog](./files/Screenshot-dialog-elfinder.png)

### Access elFinder files from Python

With the help of some utility functions in Python, you can also operate the files in the file manager:

Expand All @@ -65,7 +66,7 @@ files = elfinder_listdir('/home')
print(files)
```

## S3 backend
### Using elFinder with remote files on S3

You can use it to operate remote files on S3, by mount the S3 bucket to the browserfs. See the example below:

Expand Down

0 comments on commit 8ab7d4e

Please sign in to comment.