Quickstart

Use this guide to go from a new account to a published play as quickly as possible.

Key Steps

  • Create account
  • Setup account
  • Submit play
  • View play
  • Share play
  • Track performance
  • Get paid

Create Account

  • Sign up with GitHub to create your Playbooks account.
  • Verify your account via the email confirmation.
  • Once your account is live, move into the setup wizard.

Setup Account

  • Access the setup wizard from your home feed.
  • Complete the recommended steps for the best experience and to verify your account.
  • Finish merchant setup so your account can receive transfers and payouts.

For a deeper breakdown of account settings, team behavior, and merchant responsibilities, see Accounts and Merchant.

Submit Play

  • Paste a GitHub repository URL into the submission field.
  • Playbooks will use frontier models to dissect your play, map it into our taxonomy, and prepare it for deployment on our infrastructure.
  • Configure the demo until it deploys successfully.
  • Complete the final review and publish your play.

For more on deployment strategies, environment variables, private files, and debugging, see Demos.

View Play

  • Open your play from your profile after it is published.
  • Familiarize yourself with the play experience and the actions available to you, including bookmarks, cloning, downloading, and sharing.
  • This is also a good time to download the CLI and get familiar with that interface through CLI Quick Start.
  • Use the visibility settings to control whether it appears in the marketplace or stays available by direct URL only.

Share Play

  • Familiarize yourself with the built-in sharing tools by sending your play to yourself or another user.
  • Use marketplace visibility or a direct private URL depending on how widely you want to distribute it.
  • Use @playbooks/widgets to embed your play directly on your own website.

Track Performance

  • Follow verified play activity through The Ledger.
  • Use the public and private ledger views to monitor performance and earnings.
  • Expect the ledger to process activity on a daily cycle with a rolling verification lag.

Get Paid

  • Keep your merchant and account in good standing. For setup details, see Merchant.
  • Playbooks will automatically aggregate ledger activity into a single transfer on a daily basis.
  • Manage payout settings and merchant activity from your account dashboard.

For more on the revenue share model and the 60/40 split, see The Ledger.

PrevWelcomeNextInfrastructure