Skip to content

Commit

Permalink
Merge pull request #157 from 10up/tweak/readme
Browse files Browse the repository at this point in the history
add banner image, tweak badges, fix license references
  • Loading branch information
dkotter authored Sep 5, 2024
2 parents 0f4107b + e9d8af5 commit cac435a
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 18 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# ![Eight Day Week Print Workflow](https://github.com/10up/eight-day-week/blob/develop/.wordpress-org/banner-1544x500.png "Eight Day Week Print Workflow")
# Eight Day Week Print Workflow

> Optimize publication workflows by using WordPress as your print CMS.
![Eight Day Week](https://github.com/10up/eight-day-week/blob/develop/.wordpress-org/banner-1544x500.png "Eight Day Week Print Workflow")

[![Support Level](https://img.shields.io/badge/support-stable-blue.svg)](#support-level) ![WordPress tested up to version](https://img.shields.io/wordpress/plugin/tested/eight-day-week-print-workflow?label=WordPress) [![GPLv2 License](https://img.shields.io/github/license/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/blob/develop/LICENSE.md) [![Dependency Review](https://github.com/10up/eight-day-week/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/dependency-review.yml) [![WordPress Plugin Version](https://img.shields.io/wordpress/plugin/v/eight-day-week-print-workflow?logo=wordpress&logoColor=FFFFFF&label=Playground%20Demo&labelColor=3858E9&color=3858E9)](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/10up/eight-day-week/develop/.wordpress-org/blueprints/blueprint.json)

[![Support Level](https://img.shields.io/badge/support-stable-blue.svg)](#support-level) ![WordPress tested up to version](https://img.shields.io/wordpress/plugin/tested/eight-day-week-print-workflow?label=WordPress) [![GPLv2 License](https://img.shields.io/github/license/10up/eight-day-week.svg)](https://github.com/10up/eight-day-week/blob/develop/LICENSE.md) [![WordPress Plugin Version](https://img.shields.io/wordpress/plugin/v/eight-day-week-print-workflow?logo=wordpress&logoColor=FFFFFF&label=Playground%20Demo&labelColor=3858E9&color=3858E9)](https://playground.wordpress.net/?blueprint-url=https://raw.githubusercontent.com/10up/eight-day-week/develop/.wordpress-org/blueprints/blueprint.json)
[![E2E tests](https://github.com/10up/eight-day-week/actions/workflows/cypress.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/cypress.yml) [![PHP Standards Scrutinizer](https://github.com/10up/eight-day-week/actions/workflows/php-standards-scrutinizer.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/php-standards-scrutinizer.yml) [![CodeQL](https://github.com/10up/eight-day-week/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/github-code-scanning/codeql)

[![E2E tests](https://github.com/10up/eight-day-week/actions/workflows/cypress.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/cypress.yml) [![PHP Standards Scrutinizer](https://github.com/10up/eight-day-week/actions/workflows/php-standards-scrutinizer.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/php-standards-scrutinizer.yml) [![Dependency Review](https://github.com/10up/eight-day-week/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/10up/eight-day-week/actions/workflows/dependency-review.yml)
> Optimize publication workflows by using WordPress as your print CMS.
## Overview

Expand Down Expand Up @@ -49,13 +51,14 @@ Issue Statuses | Publications | Article Statuses
## Requirements

* PHP 7.4+
* [WordPress](http://wordpress.org) 5.7+
* [WordPress](http://wordpress.org) 6.4+

## Installation

Eight Day Week has no settings or configurations to set up. It just works!

## Filters & Hooks

Eight Day Week provides a number of filters and hooks for customizing and extending the plugin.

### Modules
Expand All @@ -78,13 +81,15 @@ The information displayed in the list of articles within a Print Issue is filter

Sample usage:

```
add_filter( 'Eight_Day_Week\Articles\article_columns', function( $columns ) {
$columns['byline'] = _x( 'Byline', 'Label for multiple, comma separated authors', 'your-text-domain' );
return $columns;
} );
add_filter( 'Eight_Day_Week\Articles\article_meta_byline', function( $incoming_value, $post ) {
return implode( ', ', wp_list_pluck( my_get_post_authors_function( $post ), 'display_name' ) );
}
```

### Print Issue Table

Expand Down
9 changes: 4 additions & 5 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@
"name": "10up/eight-day-week",
"description": "Tools that help improve the digital/print production workflows.",
"type": "wordpress-plugin",
"keywords": [],
"homepage": "http://10up.com",
"license": "GPLv2.0+",
"homepage": "https://github.com/10up/eight-day-week",
"license": "GPL-2.0-or-later",
"authors": [
{
"name": "10up",
"email": "plugins@10up.com",
"homepage": "http://10up.com",
"email": "opensource@10up.com",
"homepage": "https://10up.com",
"role": "Developer"
}
],
Expand Down
2 changes: 1 addition & 1 deletion eight-day-week.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* Requires PHP: 7.4
* Author: 10up
* Author URI: https://10up.com
* License: GPLv2+
* License: GPL-2.0-or-later
* Text Domain: eight-day-week-print-workflow
*
* @package Eight_Day_Week
Expand Down
11 changes: 6 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
{
"name": "eight-day-week",
"title": "Eight Day Week",
"description": "Tools that help improve the digital/print production workflows.",
"version": "1.2.4",
"description": "Tools that help improve the digital/print production workflows.",
"homepage": "http://10up.com",
"repository": {
"type": "git",
"url": ""
},
"license": "GPL-2.0-or-later",
"author": {
"name": "10up",
"email": "[email protected]",
"url": "http://10up.com"
},
"repository": {
"type": "git",
"url": ""
},
"devDependencies": {
"@10up/cypress-wp-utils": "github:10up/cypress-wp-utils#build",
"@wordpress/env": "^10.0.0",
Expand Down
5 changes: 3 additions & 2 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Contributors: 10up, observerteam, joshlevinson, brs14ku, jeffpaul
Tags: print, workflow, editorial
Tested up to: 6.6
Stable tag: 1.2.4
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
License: GPL-2.0-or-later
License URI: https://spdx.org/licenses/GPL-2.0-or-later.html

Optimize publication workflows by using WordPress as your print CMS

Expand Down Expand Up @@ -41,6 +41,7 @@ Two custom roles are added by this plugin to best model a real-world print team.
Eight Day Week has no settings or configurations to set up. It just works!

== Filters & Hooks ==

Eight Day Week provides a number of filters and hooks for customizing and extending the plugin.

**Modules**
Expand Down

0 comments on commit cac435a

Please sign in to comment.