README

Kirby 🤝 Steady

Kirby meets Steady. A plugin for Kirby Version 5 and later and php >= 8.2. Connect your Kirby site to your Steady publication. Request data for your publication, newsletter subscribers, members and plans from the Steady API.

Features

• Access the API:
  Use the steady() helper or $site->steady() site method to request publication, plans, subscriptions and newsletter subscribers for use in templates, snippets or everywhere else
• Steady Stats:
  Stay up to date with Steady Reports in a Panel section
• Display your Plans:
  Add your Steady Plans as $block or $snippet to your Website.
• Let your Content be worth it:
  Add a Paywall $block to your articles or pages.
• Adblock detection:
  Activate Adblocker detection and display the Steady Adblock Overlay.
• Member Login:
  Let your members login to your Steady publication, e.g. to deactivate the paywall for them or for a special member section.
• Steady Area:
  Your Steady dashboard for stats, plugin configuration, subscribers and members.

Get Started

Intallation with Composer

Simply install the plugin with composer.

composer require soerenengels/kirby-steady

Quick setup

For basic usage, add your required REST API-Key in your config.php. Keep the key secure.

return [
  'options' => [
    'soerenengels.steady.token' => '...',
  ]
];

Documentation

Jump to the documentation.

More

Available Translations

• English
• German

Develop

Use PHPStan via vendor/bin/phpstan to check the code.

License

MIT

Credits

Sören Engels