Skip to content

Commit 5ff33c7

Browse files
author
pooya parsa
committed
update readme
1 parent ed3b5e3 commit 5ff33c7

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
1-
# 🇭TTP 🇫ilesystem
1+
# HTTP Filesystem
22

33
[![Standard JS][standard-src]][standard-href]
44
[![david dm][david-src]][david-href]
55
[![codecov][codecov-src]][codecov-href]
66
[![circleci][circleci-src]][circleci-href]
7-
87
[![npm version][npm-v-src]][npm-v-href]
98
[![npm downloads][npm-dt-src]][npm-dt-href]
109
[![package phobia][packagephobia-src]][packagephobia-href]
1110

12-
### **NOTE** This module is under development and not ready for any production use!
13-
1411
Expose filesystem via HTTP and access it from the other side!
1512

1613
This module works best with [memory-fs](https://github.com/webpack/memory-fs).
@@ -51,7 +48,7 @@ mfs.writeFileSync('/test/file.txt', 'Works!')
5148
app.use('/mfs', HTTPFSMiddleware(mfs))
5249
```
5350

54-
You can now browse filesystem via a normal browser via http://localhost:8080/mfs/
51+
You can now browse filesystem with broweser: http://localhost:8080/mfs/
5552

5653
## Client
5754

@@ -74,8 +71,8 @@ fs.readFile('/test/file.txt').then((contents) => {
7471

7572
### Options
7673

77-
- `endpoint`: HTTP Endpoint of server
78-
- `maxAge`: Time for cache
74+
- `endpoint`: Address endpoint of server
75+
- `maxAge`: Time to keep requests in cache
7976

8077
## License
8178

0 commit comments

Comments
 (0)