From 950984f254e994f0df49fe534471a5b687e283fa Mon Sep 17 00:00:00 2001 From: Fernando Fernandes Date: Tue, 15 Sep 2026 16:12:54 +0200 Subject: [PATCH] docs: prepare FlashcardKit 0.1.0 --- CHANGELOG.md | 2 +- README.md | 8 ++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1451d2e..55e9f7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ All notable changes to FlashcardKit are documented here. -## Unreleased +## 0.1.0 - 2026-09-15 ### Added diff --git a/README.md b/README.md index 1d63c76..2f0bd94 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,14 @@ if let round = session.currentRound { The session plan is reproducible for identical cards, configuration, and seed. Each round exposes one correct answer and two distinct distractors; a host can submit a selected choice or explicit expiry. Presentation, timers, persistence frameworks, image resolution, vocabulary acquisition, and spaced repetition remain outside the package boundary. +## Installation + +Add FlashcardKit to a Swift package and depend on the `FlashcardKit` product: + +```swift +.package(url: "https://github.com/thatfactory/flashcardkit", from: "0.1.0") +``` + ## Documentation API documentation is published with DocC after a GitHub release. See the [FlashcardKit documentation](https://thatfactory.github.io/flashcardkit/documentation/flashcardkit/).