Coder Social home page Coder Social logo

koen12344 / deployment-info-for-fs Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 0.0 51 KB

Increase customer confidence by displaying info about your most recent Freemius-based plugin update

Home Page: https://tycoonmedia.net/

JavaScript 3.02% PHP 96.98%
freemius wordpress wordpress-plugin wordpress-plugins

deployment-info-for-fs's Introduction

Deployment info for Freemius

Contributors: koen12344
Donate link: https://tycoonmedia.net
Tags: freemius, deployment, plugin, info
Requires at least: 4.5
Tested up to: 6.2.2
Requires PHP: 7.0
Stable tag: 0.1.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Increase customer confidence by displaying info about your most recent plugin update

Description

Increase customer confidence by showing your plugin is being actively maintained. With Deployment info for Freemius you can display info about your latest Freemius plugin release on your website.

sample

Deployment info for Freemius adds the [difs_plugin_info] shortcode that can be used anywhere on your website, and will display the latest version, release date, WordPress version and amount of installs of your Freemius powered plugin.

Demo

Features

  • Easy to style with built-in CSS classes
  • Automatically updated by Freemius webhooks
  • Generates schema.org JSON-LD structured data of the SoftwareApplication type (can be turned off)
  • Plugin data is cached for maximum performance

Feel free to fork to suit your needs, or make pull requests, making sure base functionality is maintained without having to make changes to the shortcode.

Inspired by Iconic.

Installation

Here's how to install and use Deployment info for Freemius.

  1. Download the latest release
  2. Upload the content of the .zip file to your wp-content/plugins folder or upload the zip file through your WordPress dashboard.
  3. Activate the plugin
  4. Navigate to Settings > Deployment info for FS
  5. Enter your Freemius details (can be found on the My Profile page)
  6. Copy the webhook URL and add a new webhook to each plugin that you want to use with the plugin in your Freemius dashboard (Integrations > Custom Webhooks).
  7. Select only the plugin.version.released event
  8. Add the [difs_plugin_info plugin_id="12345"] shortcode wherever you want to display the release info. Obviously replace the 12345 with your Freemius plugin ID.

Shortcode Attributes

The shortcode supports the following attributes:

  • plugin_id - required - The ID of your Freemius plugin (found in Settings > Keys)
  • show_installs - Whether or not to show the amount of installs. Set to 1 or 0, default 1
  • structured_data - Whether or not the plugin should generate JSON-LD structured data. Set to 1 or 0, default 1

With all attributes: [difs_plugin_info plugin_id="12345" show_installs="1" structured_data="1"]

CSS Classes

Deployment info for Freemius comes without any CSS but can be styled through the built-in CSS classes:

  • difs-container - Parent container
  • difs-divider - The divider between the different attributes ( | )
  • difs-item - Each item is encapsulated by this class, and individual classes (difs-lastupdate, difs-released, difs-wordpress, difs-installs)

Frequently Asked Questions

Can I turn the amount of installs off?

If your plugin has a low amount of installs that may not actually work in your favor. You can choose not to display them by adding the show_installs="0" attribute to the shortcode.

Changelog

0.1.0

  • Initial release

deployment-info-for-fs's People

Contributors

koen12344 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.