From 2606dbc750aec6945aa372c5db1f695b9869fe56 Mon Sep 17 00:00:00 2001 From: Emma K Alexandra Date: Thu, 14 Mar 2024 21:34:30 -0400 Subject: [PATCH] Update README.md --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e8320829..80a0cad7 100644 --- a/README.md +++ b/README.md @@ -57,17 +57,22 @@ let ashburn = try GTFSStop("STN_N12") print(ashburn.name) // "ASHBURN METRORAIL STATION" ``` +## Documentation + +Full documentation is available at or within Xcode. + +To view documentation within Xcode, within the menu navigate to `Product > Build Documentation`. WMATA's documentation will appear under `Workspace Documentation` within the Developer Documentation window. Navigate to `Window > Developer Documentation` to open this window. + ## OS Support WMATA.swift commits to supporting current minus 2 OS versions. Currently, WMATA.swift is compatible with macOS 12, iOS 15, tvOS 15, watchOS 8 or higher. -## Documentation +## Versioning -Full documentation is available at or within Xcode. +WMATA.swift uses semantic versioning. Only major versions will contain breaking changes. -To view documentation within Xcode, within the menu navigate to `Product > Build Documentation`. WMATA's documentation will appear under `Workspace Documentation` within the Developer Documentation window. Navigate to `Window > Developer Documentation` to open this window. ## Dependencies