Skip to content

Commit

Permalink
Update README, add items to readme.txt required by readme.txt validat…
Browse files Browse the repository at this point in the history
…or (#36)
  • Loading branch information
geoffturk committed Sep 6, 2018
1 parent e81abed commit abf8f51
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 32 deletions.
64 changes: 33 additions & 31 deletions README.md
@@ -1,13 +1,24 @@
# 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.

[![Join the chat at https://gitter.im/poetapp/Lobby](https://badges.gitter.im/poetapp/Lobby.svg)](https://gitter.im/poetapp/Lobby)

The Po.et WordPress Plugin allows you to automatically submit your blog posts to Po.et. Once you install and configure it, every time you post a new blog entry it will automatically be posted through Po.et's Frost API to the Po.et Network.

## How to Install

### From source
### From the WordPress Plugin Directory

You will need Phing and Git installed to build from source.
The Official Po.et WordPress Plugin can be found here: https://wordpress.org/plugins/po-et/

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

Go to the [releases](https://github.com/poetapp/wordpress-plugin/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 at the top of the page.

### 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:

Expand All @@ -19,50 +30,41 @@ From within the checked out repository, run:

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](https://github.com/poetapp/wordpress-plugin/releases) section of the repository and download the most recent release.
## How to Use

Then, from your WordPress administration panel, go to `Plugins > Add New` and click the `Upload Plugin` button on the top of the page.
From your WordPress administration panel go to `Plugins > Installed Plugins` and scroll down until you find `Po.et`. You will need to activate it first, then click on `Settings` to configure it.

### From the WordPress Plugin Directory
The Official Po.et WordPress Plugin can be found at https://wordpress.org/plugins/po-et/.
### Configuration

## 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.
#### Author Name

## Badge
Place the shortcode `[poet-badge]` anywhere in your article to display the Po.et Badge as proof that the article was timestamped.
This field will be used to set the `author` field on the Po.et Claim that is written to the Po.et Network. Set it to your name, pen name, blog's name, etc.

#### API URL

## Configuration
The URL of the Frost API, which is: https://api.frost.po.et/works

### 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.
#### Token

### API URL
The URL of the Frost API. It'll default to Frost's URL once it's released.
You will need an API token, which you can obtain here: https://frost.po.et

### 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?

### Post articles to API automatically on insert or update?
Use this checkbox to enable or disable automatic posting.

## Developers
## Badge

Place the shortcode `[poet-badge]` anywhere in your article to display the Po.et Badge as proof that the article was timestamped on the Po.et Network and anchored to the Bitcoin blockchain.

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.
## Developers

To ensure your code is formatted the WordPress way, you can run the PHP code sniffer, using the WordPress coding ruleset.
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.

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):
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](LICENSE).

It is also assumed you have Composer installed in your home directory, so you may need to adjust the `installed_paths` directive to match your Composer installation directory.
7 changes: 6 additions & 1 deletion readme.txt
@@ -1,6 +1,6 @@
=== Po.et ===
Contributors: lautarodragan, knowledgearc
Donate link:
Donate link: https://www.po.et
Tags: po.et, frost, decentralized, intellectual property, bitcoin
Requires at least: 4.1
Requires PHP: 5.2.4
Expand Down Expand Up @@ -64,3 +64,8 @@ Code style and structure fixes.

= 1.0.0 =
Initial release.

== Upgrade Notice ==

= 1.0.2 =
Upgrade to have the Po.et badge displayed in your posts link to your work in Po.et Explorer: https://explorer.po.et

0 comments on commit abf8f51

Please sign in to comment.