chowdhurynawaf / tutti Goto Github PK

Tutti is a Swift library that helps you create onboarding expericences, like quick hints and single- or multi-screen tutorials.

Tutti will only display a hint/tutorial once by default. You can reset the display state of a hint/tutorial if you want to display it multiple times.

Tutti also supports user-specific hints/tutorials. Just set the userId parameter and Tutti will display the hint/tutorial once for every new user.

The easiest way to add Tutti to your project is to use Swift Package Manager:

https://github.com/danielsaidi/Tutti.git

pod 'Tutti'

github "danielsaidi/Tutti"

To manually add Tutti to your app without a dependency manager, clone this repository, add Tutti.xcodeproj to your project and Tutti.framework as an embedded app binary and target dependency.

This repository contains a demo app that demonstrates different types of hints and tutorials. To try it out, open and run the Tutti.xcodeproj project.

Tutti comes with a set of built-in hint types that can be used for different purposes.

• StandardHint - A basic hint with no specific behavior.
• DeferredHint - Requires a certain number of presentation attempts before it is presented.
• CorrectBehaviorHint - Can be used to show a hint when a user is not behaving as intended.

You can also create your own custom hint types by implementing the Hint protocol.

Check out this guide for more information on how to create and present hints.

Tutti comes with a set of built-in tutorial types that can be used for different purposes.

• StandardTutorial - A basic tutorial with no specific behavior.
• DeferredTutorial - Requires a certain number of presentation attempts before it is presented.
• CorrectBehaviorTutorial - Can be used to show a tutorial when a user is not behaving as intended.

You can also create your own custom tutorial types by implementing the Tutorial protocol.

Check out this guide for more information on how to create and present tutorials.

I hope you like this library. Feel free to reach out if you have questions or if you want to contribute in any way:

• E-mail: [email protected]
• Twitter: @danielsaidi
• Web site: danielsaidi.com

Tutti is available under the MIT license. See LICENSE file for more info.