Skip to content

Commit 85b9249

Browse files
committed
Add readme
1 parent 984d867 commit 85b9249

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

readme.markdown

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
11
# tty-browserify
2+
3+
Browser stubs for the Node.js `require('tty')` module.
4+
5+
Browserify uses this module when you do `require('tty')` in a bundle. You should normally not use it directly.
6+
7+
## API
8+
9+
### `tty.isatty()`
10+
11+
Returns false.
12+
13+
### `new tty.ReadStream()`
14+
15+
Throws an error.
16+
17+
### `new tty.WriteStream()`
18+
19+
Throws an error.
20+
21+
## License
22+
23+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)