Skip to content

Commit a64dd7d

Browse files
authored
update readme for 1.0.0 (#39)
1 parent ca922e3 commit a64dd7d

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,21 @@
11
# swift-log
22

3-
A Logging API package for Swift 5.
3+
A Logging API package for Swift. Version `1.0.0` requires Swift 5.0 but in due course we will also tag a mostly compatible version for Swift 4 (which will be tagged `0.x`) to ease your transition towards Swift 5.
44

55
First things first: This is the beginning of a community-driven open-source project actively seeking contributions, be it code, documentation, or ideas. Apart from contributing to `swift-log` itself, there's another huge gap at the moment: `swift-log` is an _API package_ which tries to establish a common API the ecosystem can use. To make logging really work for real-world workloads, we need `swift-log`-compatible _logging backends_ which then either persist the log messages in files, render them in nicer colors on the terminal, or send them over to Splunk or ELK.
66

7-
What `swift-log` provides today can be found in the [API docs][api-docs]. At this moment, we have not tagged a version for `swift-log`, but we will do so soon after Swift 5 gets released.
8-
9-
---
10-
11-
**NOTE**: You will need [Xcode 10.2](https://itunes.apple.com/us/app/xcode/id497799835) or [Swift 5.0](https://swift.org/download/#swift-50) to try out `swift-log`.
12-
13-
---
7+
What `swift-log` provides today can be found in the [API docs][api-docs].
148

159
## Great, what's the tl;dr
1610

1711
If you have a server-side Swift application, or maybe a cross-platform (for example Linux & macOS) app/library, and you would like to log, we think targeting this logging API package is a great idea. Below you'll find all you need to know to get started.
1812

1913
#### Adding the dependency
2014

21-
To depend on the logging API package, you need to declare your dependency in your `Package.swift`:
15+
`swift-log` is designed for Swift 5, the `1.0.0` release requires Swift 5 (however we will soon tag a `0.x` version that will work with Swift 4 for the transition period). To depend on the logging API package, you need to declare your dependency in your `Package.swift`:
2216

2317
```swift
24-
// it's early days here so we haven't tagged a version yet, but will soon
25-
.package(url: "https://github.com/apple/swift-log.git", .branch("master")),
18+
.package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
2619
```
2720

2821
and to your application/library target, add `"Logging"` to your `dependencies`, e.g. like this:

0 commit comments

Comments
 (0)