Skip to content

Commit 48df88b

Browse files
committed
Add coverage badge and link to docs
1 parent 3740f4f commit 48df88b

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
11
# LaunchAgent
22

3-
![SwiftPM] ![Swift5.2] ![license] ![build]
3+
![SwiftPM] ![Swift5.2] ![license] ![build] ![coverage]
44

55
[SwiftPM]: https://img.shields.io/badge/SwiftPM-compatible-success.svg
66
[swift]: https://developer.apple.com/swift/
77
[Swift5.2]: https://img.shields.io/badge/swift-5.2-orange.svg?style=flat
88
[spm]: https://swift.org/package-manager/
99
[license]: https://img.shields.io/github/license/emorydunn/LaunchAgent.svg?style=flat
1010
[build]: https://github.com/emorydunn/LaunchAgent/workflows/Swift/badge.svg
11+
[docs]: https://emorydunn.github.io/LaunchAgent/
12+
[coverage]: https://emorydunn.github.io/LaunchAgent/badge.svg
1113

12-
LaunchAgent provides an easy way to programatically create and maintain [`launchd`][launchd] agents and daemons without needing to manually build Property Lists.
14+
LaunchAgent provides an easy way to pragmatically create and maintain [`launchd`][launchd] agents and daemons without needing to manually build Property Lists.
15+
16+
Take a look at the full [documentation][docs].
1317

1418
[launchd]: http://www.launchd.info
1519

1620
## LaunchAgent
1721

18-
A LaunchAgent can be createdinstantiated with either an array of program arguments:
22+
A LaunchAgent can be created with either an array of program arguments:
1923
```swift
2024
LaunchAgent(label: "local.PythonServer", program: ["python", "-m", "SimpleHTTPServer", "8000"])
2125
```
@@ -42,7 +46,6 @@ do {
4246
} catch {
4347
print("Unexpected error:" error)
4448
}
45-
4649
```
4750

4851
### Using LaunchControl to read and write LaunchAgents
@@ -70,8 +73,8 @@ Some keys use their own type to encapsulate a complex dictionary value.
7073
|------------------|----------|-----------|-------|
7174
| Label | String | true | |
7275
| Disabled | String | true | |
73-
| Program | String | true | Either `Program` or `ProgramArguments` can be set. |
74-
| ProgramArguments | [String] | true | Either `Program` or `ProgramArguments` can be set. |
76+
| Program | String | true | |
77+
| ProgramArguments | [String] | true | |
7578
| EnableGlobbing | Bool | true | deprecated in macOS |
7679

7780
### Program
@@ -105,7 +108,7 @@ Some keys use their own type to encapsulate a complex dictionary value.
105108
| initGroups | Bool | true | |
106109
| rootDirectory | String | true | |
107110

108-
### Run Constriants
111+
### Run Constraints
109112
| Key Name | Key type | Supported | Notes |
110113
|------------------------|----------|-----------|-------|
111114
| launchOnlyOnce | Bool | true | |

0 commit comments

Comments
 (0)