Welcome to the AudreyJoinStories documentation! This documentation provides detailed information and guidelines on using the AudreyJoinStories framework to create captivating and interactive stories for your applications. Whether you are a beginner or an experienced developer, this documentation aims to help you build engaging storytelling experiences for your users. So, let’s dive in and explore the world of AudreyJoinStories!


To start using AudreyJoinStories in your project, follow the steps below:

  1. Ensure you have CocoaPods installed on your system.
  2. Create a new Xcode project or open an existing project.
  3. Navigate to your project’s root directory in the Terminal.
  4. Create a new Podfile by running the command: pod init
  5. Edit the Podfile and add pod 'AudreyJoinStories'
  6. Save the Podfile and run pod install command
  7. Open the .xcworkspace file for your project.

Now you have successfully installed AudreyJoinStories and are ready to utilize its powerful features for crafting immersive storytelling experiences!


To get started with AudreyJoinStories, follow the steps below:

Step 1: Import AudreyJoinStories

In the file where you want to use AudreyJoinStories, import the framework using the following code:

// Swift
import AudreyJoinStories

// Objective-C
@import AudreyJoinStories;

Now you can access all the functionalities provided by AudreyJoinStories in your project.

Step 2: Create a Story View

To create a story view, initialize an instance of AJSStoryView and configure it according to your requirements. You can set the frame, background color, and more using the properties of the story view.

// Swift
let storyView = AJSStoryView(frame: CGRect(x: 0, y: 0, width: 300, height: 500))
storyView.backgroundColor = UIColor.white

// Objective-C
AJSStoryView *storyView = [[AJSStoryView alloc] initWithFrame:CGRectMake(0, 0, 300, 500)];
storyView.backgroundColor = [UIColor whiteColor];

Now you have created a story view and can further customize it as desired.

Step 3: Add Stories and Chapters

AudreyJoinStories allows you to add stories and chapters to your Story View. A story consists of multiple chapters, each containing its own content and media. Follow the code snippet given below to add a story and its chapters:

// Swift
let story = AJSStory(id: "story1")
story.addChapter(AJSChapter(id: "chapter1", content: "This is the content of chapter 1."))

// Objective-C
AJSStory *story = [[AJSStory alloc] initWithId:@"story1"];
[story addChapter:[[AJSChapter alloc] initWithId:@"chapter1" content:@"This is the content of chapter 1."]];

You can add as many chapters as you want to a story. Each chapter can contain different content such as images, text, videos, etc.

Step 4: Display the Story View

After configuring the story view and adding your desired stories and chapters, simply add the story view as a subview to your desired parent view using the following code:

// Swift

// Objective-C
[parentView addSubview:storyView];

Now you should be able to see the story view with your added stories and chapters displayed.


AudreyJoinStories provides several options for customizing the appearance and behavior of your stories. Below are some of the customization options:

Available Customization Options

  • Story View: You can customize the background color, frame, and more of the story view.
  • Story: You can set the cover image, autoplay settings, navigation buttons, and more for a specific story.
  • Chapter: Customize the content, media type, appearance, and transitions for individual chapters.
  • Text Styles: Personalize the font, size, color, and other attributes of the text displayed in your stories.
  • Theme: Apply a theme to your stories for consistent visual styling across all chapters.

By utilizing these customization options, you can create visually appealing and unique storytelling experiences for your users.

Advanced Topics

AudreyJoinStories offers additional advanced features and functionalities to enhance your storytelling experiences. Some of these topics include:

Topic 1: Creating Interactive Chapters

Learn how to create interactive chapters using gestures, animations, and user interactions to engage your audience further.

Topic 2: Implementing Story Analytics

Discover how to track and analyze various metrics of your stories, such as user engagement, completion rates, and more.

Topic 3: Integrating External Media

Explore techniques to seamlessly integrate external media, such as videos, images, and audio, into your AudreyJoinStories chapters.


Congratulations! You have just completed a comprehensive guide to AudreyJoinStories, from installation to customization and advanced topics. Armed with this knowledge, you can now create compelling and captivating stories for your applications. Feel free to explore the documentation further and experiment with various features and options to create unique storytelling experiences. Happy storytelling!