Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed typo in README.markdown and trim trailing whitespaces. #217

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed typo in README.markdown and trim trailing whitespaces. #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ So what usually happens is either:

* Large programs with configure scripts disabling line editing if readline is not present in the system, or not supporting it at all since readline is GPL licensed and libedit (the BSD clone) is not as known and available as readline is (real world example of this problem: Tclsh).
* Smaller programs not using a configure script not supporting line editing at all (A problem we had with `redis-cli`, for instance).

The result is a pollution of binaries without line editing support.

So I spent more or less two hours doing a reality check resulting in this little library: is it *really* needed for a line editing library to be 20k lines of code? Apparently not, it is possibe to get a very small, zero configuration, trivial to embed library, that solves the problem. Smaller programs will just include this, supporting line editing out of the box. Larger programs may use this little library or just checking with configure if readline/libedit is available and resorting to Linenoise if not.
Expand Down Expand Up @@ -133,7 +133,7 @@ just that. Both functions return -1 on error and 0 on success.

Sometimes it is useful to allow the user to type passwords or other
secrets that should not be displayed. For such situations linenoise supports
a "mask mode" that will just replace the characters the user is typing
a "mask mode" that will just replace the characters the user is typing
with `*` characters, like in the following example:

$ ./linenoise_example
Expand Down Expand Up @@ -244,7 +244,7 @@ user typed. You can do this by calling the following function:

void linenoiseClearScreen(void);

## Asyncrhronous API
## Asynchronous API

Sometimes you want to read from the keyboard but also from sockets or other
external events, and at the same time there could be input to display to the
Expand Down