add note about convergence tag (#20)

motivation: starting convergence period for swift-metrics 1.0.0 release

changes:
* add info in readme about the convergence phase/version
* format
This commit is contained in:
tomer doron 2019-04-22 10:20:44 -07:00 committed by GitHub
parent 6db51d5f32
commit b017e02759
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 11 deletions

View File

@ -17,8 +17,9 @@ If you have a server-side Swift application, or maybe a cross-platform (e.g. Lin
To add a dependency on the metrics API package, you need to declare it in your `Package.swift`:
```swift
// it's early days here so we haven't tagged a version yet, but will soon
.package(url: "https://github.com/apple/swift-metrics.git", .branch("master")),
// SwiftMetrics is converging towards the 1.0.0 release as of April 22nd 2019, the tag is 1.0.0-convergence.1
// To depend on this release, you can use
.package(url: "https://github.com/apple/swift-metrics.git", from: "1.0.0-convergence.1"),
```
and to your application/library target, add "Metrics" to your dependencies:

View File

@ -78,7 +78,6 @@ public class Counter {
public func reset() {
self.handler.reset()
}
}
public extension Counter {
@ -483,7 +482,6 @@ public final class MultiplexMetricsHandler: MetricsFactory {
}
}
private class MuxCounter: CounterHandler {
let counters: [CounterHandler]
public init(factories: [MetricsFactory], label: String, dimensions: [(String, String)]) {
@ -528,7 +526,6 @@ public final class MultiplexMetricsHandler: MetricsFactory {
/// Ships with the metrics module, used for initial bootstraping.
public final class NOOPMetricsHandler: MetricsFactory, CounterHandler, RecorderHandler, TimerHandler {
public static let instance = NOOPMetricsHandler()
private init() {}
@ -543,9 +540,9 @@ public final class NOOPMetricsHandler: MetricsFactory, CounterHandler, RecorderH
return self
}
public func destroyCounter(_ handler: CounterHandler) {}
public func destroyRecorder(_ handler: RecorderHandler) {}
public func destroyTimer(_ handler: TimerHandler) {}
public func destroyCounter(_: CounterHandler) {}
public func destroyRecorder(_: RecorderHandler) {}
public func destroyTimer(_: TimerHandler) {}
public func increment(by: Int64) {}
public func reset() {}