Automatically post to Frost ❄️ from WordPress
PHP CSS Other
Switch branches/tags
Nothing to show
Clone or download

README.md

Po.et WordPress Plugin

The Po.et WordPress Plugin allows you to automatically submit your blog posts to Frost. All you need to do is install and configure it, then every time you post a new blog entry it'll automatically be posted to Frost.

How to Install

From source

You will need Phing and Git installed to build from source.

To complete the following steps, you will need to open a command line terminal.

Clone the Github repository:

git clone https://github.com/poetapp/wordpress-plugin.git

From within the checked out repository, run:

phing package

The packaged zip file will be available under the build directory which is created under your locally cloned git repository.

From this repository

Go to the releases section of the repository and download the most recent release.

Then, from your WordPress administration panel, go to Plugins > Add New and click the Upload Plugin button on the top of the page.

From the WordPress Plugin Directory

The Official Po.et WordPress Plugin can be found at https://wordpress.org/plugins/po-et/.

How to Use

From your WordPress administration panel go to Plugins > Installed Plugins and scroll down until you find Po.et. You'll need to activate it first. Then click con Settings to configure it.

Badge

Place the shortcode [poet-badge] anywhere in your article to display the Po.et Badge as proof that the article was timestamped.

Configuration

Author Name

This field will be used to set the author field on the Po.et work. Set it to your name, pen name, blog's name, etc.

API URL

The URL of the Frost API. It'll default to Frost's URL once it's released.

Token

The API token provided to you by Frost upon registry. This is what ties the published works to your Frost account.

Post articles to API automatically on insert or update?

Use this checkbox to enable or disable automatic posting.

Developers

The Po.et WordPress plugin welcomes additions from developers. To ensure code is consistent and that all developers can focus on building great features rather than deciphering various coding styles, the Po.et WordPress plugin adheres to the WordPress coding standards.

To ensure your code is formatted the WordPress way, you can run the PHP code sniffer, using the WordPress coding ruleset.

There are various ways to install both PHPCS and the WordPress coding ruleset but the easiest method is to install it globally using Composer. Assuming you have Composer and PHPCS installed and available from the command line, run the following from a terminal (assuming you are on Linux or a *nix derivative):

composer global require wp-coding-standards/wpcs
phpcs --config-set installed_paths ~/.composer/vendor/wp-coding-standards/wpc

It is also assumed you have composer installed to your home directory, so you may need to adjust the installed_paths directive to match your composer installation directory.

License

The Po.et WordPress plugin is licensed under the terms of the MIT License and is available for free. See LICENSE.