.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
This text does not appear on pypi or github. It is a comment.
=========================
collective.smartappbanner
=========================
Customisable smart app banners on Plone for iOS, Android, and Windows.
.. image:: https://img.shields.io/travis/collective/collective.smartappbanner/master.svg
:target: http://travis-ci.org/collective/collective.smartappbanner
Features
--------
- Uses `smart-app-banner.js <https://github.com/kudago/smart-app-banner>`_ from Diva Yv / Kudago. (Thanks!)
- Adds meta tags, which are handled by the javascript to show a banner for your app when viewed on a mobile device.
- For ios (Apple) the meta tag is actually enough: just fill in the ios App id and ignore all other options.
The javascript is only used for Android and Windows.
.. Examples
--------
This add-on can be seen in action at the following sites:
- Is there a page on the internet where everybody can see the features?
Translations
------------
This product has been translated into
- Dutch (Maurits van Rees)
Installation
------------
Install collective.smartappbanner by adding it to your buildout::
[buildout]
...
eggs =
collective.smartappbanner
and then running ``bin/buildout``
After you start your Plone Site, you can install it in the add-ons control panel.
This adds a control panel where you can configure the app name, app IDs, etcetera.
We only create meta tags if at least one of the app ids is filled in.
Debugging
---------
You can test how the banner looks, also on for example a laptop, by appending ``?force_platform=ios`` to the URL in your browser.
Options are ``ios``, ``android``, and ``windows``.
Contribute
----------
- Issue Tracker: https://github.com/collective/collective.smartappbanner/issues
- Source Code: https://github.com/collective/collective.smartappbanner
Support
-------
If you are having issues, please let us know by using the issue tracker.
License
-------
The project is licensed under the GPLv2.
Contributors
============
- Lennard Huiskes, l.huiskes@zestsoftware.nl
- Maurits van Rees, m.van.rees@zestsoftware.nl
Changelog
=========
1.0.1 (2017-05-17)
------------------
- Upgrade step: do not compress our javascript in the registry.
It is already compressed. [maurits]
- Updated javascript with fix for double ios banner.
This includes a fix from `tomek-f <https://github.com/kudago/smart-app-banner/pull/80>`_.
[maurits]
1.0 (2017-05-16)
----------------
- Switched to `smart-app-banner.js <https://github.com/kudago/smart-app-banner>`_ by Diva Yv / Kudago. (Thanks!)
If you have installed the previous alpha version, please take a note of your control panel settings,
and then deactivate and activate the package.
[maurits]
- Translate 'on the App Store' and 'in Google Play'. [maurits]
1.0a1 (2017-05-12)
------------------
- Initial release with smartbanner.js 1.5.0.
[lennard, maurits]
