diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 0000000..cbdac9e --- /dev/null +++ b/.lycheeignore @@ -0,0 +1,4 @@ +# The DocC site on GitHub Pages is published by .github/workflows/docs-pages.yml only after +# a merge to master, so the link check can't reach it from a pull request before the first +# deploy. Only this exact URL is excluded. +^https://tuner88\.github\.io/iOSSystemSoundsLibrary/documentation/systemsoundslibrary/$ diff --git a/README.md b/README.md index 956d74a..86f0ec2 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ A reference list of the system sounds built into iOS, plus a small demo app that - Run the demo project **on a real device** to hear all available system sounds. The iOS Simulator does not play system sounds. - See the [screenshot](#screenshot). +- API documentation for the `SystemSoundsLibrary` Swift package: > [!NOTE] > Apple does not officially document these SystemSoundIDs or file names. The mappings below were collected on iOS 7 and **may differ, be missing, or be added on other iOS versions**. Always test on the iOS versions you support.