Skip to content

Commit 9d7ff0e

Browse files
committed
Better description of filedrop
1 parent ed5cd1a commit 9d7ff0e

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
FileDrop is a simple NodeJS application to upload and share files on local networks.
44

5+
It is written to work completely offline. That means you can host it on a private network or an internetless access point.
6+
57
![Screenshot](screenshot.png)
68

79
# Installing
@@ -21,6 +23,22 @@ filedrop --target /path/to/savedir
2123
docker run -d -p 8080:8080 zix99/filedrop:latest
2224
```
2325

26+
## From source
27+
28+
First, clone the repo...
29+
30+
Then:
31+
32+
```bash
33+
npm install
34+
npm start
35+
```
36+
37+
To develop:
38+
```bash
39+
npm run dev
40+
```
41+
2442
# Configuration
2543

2644
Filedrop uses the [rc](https://www.npmjs.com/package/rc) module for configuration. To configure, simply use environment variables like `filedrop_`, use a `.filedroprc` file, or simply change `config.js`.

0 commit comments

Comments
 (0)