# ephread/Instructions

Create walkthroughs and guided tours (coach marks) in a simple way, with Swift.

Repository: https://github.com/ephread/Instructions
Canonical: https://ross.abutalabs.com/products/instructions
Language: Swift
License: MIT
License Family: permissive
Topics: coach-marks, tour, walkthrough
Last push: 2024-06-05T16:14:17+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 3989, "days_push": 819, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 5200, forks 478 (observed 2026-08-28T04:09:12.098873+00:00)

## What it is
A Swift library for adding customizable coach marks and guided tours to iOS apps. It supports customizable highlights, views, positions, skippable tours, and app extensions, and is now in maintenance mode with a recommendation to migrate to SwiftUI's TipKit.

## Use cases
- add onboarding coach marks to an iOS app
- create a guided tour highlighting UI elements
- show walkthrough overlays for first-time users
- build skippable feature tours on iPhone and iPad
- add animated tooltips pointing at UI controls

## When to choose
- you need coach marks in a UIKit-based iOS app
- you require customizable highlight and overlay views
- you need app extension support for tours
- you want a mature library with RTL and size-transition support

## When to avoid
- you are starting a new SwiftUI project (use TipKit instead)
- you need cross-controller walkthroughs or multiple simultaneous coach marks
- you expect new features or active development

## Facets
- artifact type: library
- maturity: maintenance
- function: ui-components, animation
- domain: mobile-development, frontend, developer-tools
- platform: -
- tags: coach-marks, walkthrough, guided-tour, onboarding, deprecated, ios, swift, mobile

## Member repositories
- ephread/Instructions (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:12.098873+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:00:15.477927+00:00, confidence not recorded.
  - readme: https://github.com/ephread/Instructions (fetched 2026-08-28T04:09:12.098873+00:00, sha e6064b760dcb)
- Data as of 2026-08-30T08:39:29.467469+00:00.