Updated readme

This commit is contained in:
nathan 2014-10-24 20:04:48 +02:00
commit 59890d92a0
1 changed files with 19 additions and 0 deletions

19
README.md Normal file
View File

@ -0,0 +1,19 @@
inputConsole
============
Unbuffered input on the console for java applications.
This small library is very similar to what JLine provides, however it does 4 things very differently:
1) Only provides unbuffered input.
- Backspace functionality for line input is preserved.
- Ctrl-C (SIGINT) is also preserved in windows
2) Uses native calls (instead of shell execution) for linux & mac terminal configuration
3) supports unsupported teminals (for example, while in an IDE ), so in.read() will still return (a line is split into chars, then fed to consumer). The enter key must still be pressed.
4) multi-threaded, intelligent buffering of command input for simultaneous input readers on different threads
This is for cross-platform use, specifically - linux 32/64, mac 32/64, and windows 32/64. Java 6+
ANSI output to console is also supported, and is required for backspace functionality to work when echo is enabled.