Skip to content

Commit 938fb33

Browse files
committed
Small documentation fixes.
1 parent 56c8df2 commit 938fb33

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Diff for: README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
## Overview
1111

1212
This is a library supporting the development of command-line tools in
13-
the programming language Swift on macOS. The library provides the following
14-
functionality:
13+
the programming language Swift on macOS. It also compiles under Linux.
14+
The library provides the following functionality:
1515

16-
- Management of command-line arguments
17-
- Usage of escape sequences in XTerms
16+
- Management of command-line arguments,
17+
- Usage of escape sequences on terminals, and
1818
- Reading strings on terminals using a lineread-inspired implementation
1919
based on the library [Linenoise-Swift](https://github.com/andybest/linenoise-swift),
2020
but supporting unicode input, multiple lines, and styled text.
@@ -143,9 +143,10 @@ CommandLineKit includes a significantly improved version of the "readline" API o
143143
styled text. It supports all the existing features such as _advanced keyboard support_, _history_,
144144
_text completion_, and _hints_.
145145

146-
The following code illustrates the usage of the LineReader API:
146+
The following code illustrates the usage of the
147+
[LineReader](https://github.com/objecthub/swift-commandlinekit/blob/master/Sources/CommandLineKit/LineReader.swift) API:
147148

148-
```
149+
```swift
149150
if let ln = LineReader() {
150151
ln.setCompletionCallback { currentBuffer in
151152
let completions = [

0 commit comments

Comments
 (0)