Skip to content
This repository has been archived by the owner on Mar 7, 2023. It is now read-only.

Commit

Permalink
added some helpers and doku
Browse files Browse the repository at this point in the history
  • Loading branch information
pfefferle committed Apr 28, 2017
1 parent bee40cd commit 9297f6f
Show file tree
Hide file tree
Showing 8 changed files with 296 additions and 5 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.DS_Store
vendor
node_modules
.DS_Store
30 changes: 30 additions & 0 deletions Gruntfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
wp_readme_to_markdown: {
target: {
files: {
'README.md': 'readme.txt'
},
},
},
makepot: {
target: {
options: {
mainFile: 'ostatus.php',
domainPath: '/languages',
exclude: ['bin/.*', '.git/.*', 'vendor/.*'],
potFilename: 'wordpress-ostatus.pot',
type: 'wp-plugin',
updateTimestamp: true
}
}
}
});

grunt.loadNpmTasks('grunt-wp-readme-to-markdown');
grunt.loadNpmTasks('grunt-wp-i18n');

// Default task(s).
grunt.registerTask('default', ['wp_readme_to_markdown']);
};
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# OStatus for Wordpress #
**Contributors:** pepijndevos, pfefferle
**Tags:** social network, ostatus, federated, bundle, mastodon, gnu, social, gnu.social, status.net
**Requires at least:** 4.5
**Tested up to:** 4.7.4
**Stable tag:** 2.0.0

A bundle of plugins that turn your blog into your private federated social network.

## Description ##

OStatus for Wordpress turns your blog into a federated social network. This means you can share and talk to everyone using the OStatus protocol, including users of Status.net/Identi.ca and Wordpress.com

The Plugin is compatible to Mastodon, gnu.social and Status.NET.

For more information about OStatus visit the [OStatus Community Group](https://www.w3.org/community/ostatus/)

This plugin bundles a few other plugins it requires to work, theses are installed automatically unless you have them already installed.

The plugin requires:

* the `PubSubHubBub`-plugin: http://wordpress.org/plugins/pubsubhubbub/
* the `host-meta`-plugin: http://wordpress.org/plugins/host-meta/
* the `webfinger`-plugin: http://wordpress.org/plugins/webfinger/
* the `Salmon`-plugin: http://wordpress.org/plugins/salmon/
* the `ActivityStream extension`-plugin: http://wordpress.org/plugins/activitystream-extension/

## Installation ##

1. Upload the plugin folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Check all the needed plugins are there and activated through the settings-page

## Frequently Asked Questions ##

### can I help you? ###
yes please!

## Changelog ##

### 2.0.0 ###
* Mastodon and gnu.social support
* PHP 7 compatibility
* small changes

### 1.2 ###
* WordPress 3.1 support

### 1.1 ###
* added functionality

### 1.0 ###
* initial version

## Upgrade Notice ##

nothing to fear

## Helping out ##

You can help!

This plugin bundles a few plugins theta implement parts of the OStatus specification.

If you are the author of a relevant plugin, or are planning one, contact us to get it included in this bundle.
19 changes: 19 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "pfefferle/wordpress-ostatus",
"description": "A Webmention plugin for WordPress http://wordpress.org/plugins/webmention/",
"require": {
"php": ">=5.6.0",
"composer/installers": "~1.0"
},
"type": "wordpress-plugin",
"license": "MIT",
"authors": [
{
"name": "Matthias Pfefferle",
"homepage": "http://notiz.blog/"
}
],
"extra": {
"installer-name": "ostatus-for-wordpress"
}
}
135 changes: 135 additions & 0 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions ostatus.php
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
<?php
/**
* Plugin Name: OStatus for WordPress
* Plugin Name: OStatus
* Plugin URI: http://wordpress.org/tags/ostatus-for-wordpress
* Description: A bundle of plugins that turn your blog into your private federated social network.
* Author: Matthias Pfefferle
* Version: 2.0.0-dev
* Author URI: http://notiz.blog/
* License: MIT
* License URI: http://opensource.org/licenses/MIT
* Version: 2.0.0
* Text Domain: ostatus
* Domain Path: /languages
*/

add_action( 'init', array( 'Ostatus', 'init' ) );
Expand All @@ -14,7 +18,7 @@
* Ostatus class
*
* @author Matthias Pfefferle
* @see http://ostatus.org
* @see https://www.w3.org/community/ostatus/
*/
class Ostatus {

Expand Down
31 changes: 31 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"name": "wordpress-ostatus",
"description": "A bundle of plugins that turn your blog into your private federated social network.",
"main": "ostatus.php",
"devDependencies": {
"grunt": "^0.4.5",
"grunt-wp-i18n": "^0.5.4",
"grunt-wp-readme-to-markdown": "^0.8.0"
},
"repository": {
"type": "git",
"url": "https://github.com/pfefferle/wordpress-ostatus.git"
},
"keywords": [
"social network",
"ostatus",
"federated",
"bundle",
"mastodon",
"gnu",
"social",
"gnu.social",
"status.net"
],
"author": "Matthias Pfefferle",
"license": "MIT",
"bugs": {
"url": "https://github.com/pfefferle/wordpress-ostatus/issues"
},
"homepage": "https://github.com/pfefferle/wordpress-ostatus"
}
7 changes: 6 additions & 1 deletion readme.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=== OStatus for Wordpress ===
Contributors: pepijndevos, pfefferle
Tags: social network, ostatus, federated, bundle, mastodon, gnu, social, status
Tags: social network, ostatus, federated, bundle, mastodon, gnu, social, gnu.social, status.net
Requires at least: 4.5
Tested up to: 4.7.4
Stable tag: 2.0.0
Expand Down Expand Up @@ -38,6 +38,11 @@ yes please!

== Changelog ==

= 2.0.0 =
* Mastodon and gnu.social support
* PHP 7 compatibility
* small changes

= 1.2 =
* WordPress 3.1 support

Expand Down

0 comments on commit 9297f6f

Please sign in to comment.