Skip to content

Commit

Permalink
Cleaning up the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronware committed Jan 15, 2020
1 parent d29f39b commit 72b5208
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
5 changes: 3 additions & 2 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ This is not the same as sticky posts. Sticky functionality can only be applied t
## How do I find just my featured posts? ##

This snippet of code will fetch the 10 most recent posts that are featured.
`<?php

``<?php
$featured_posts = new WP_Query( array(
'post_type' => 'post',
'posts_per_page' => 10,
Expand All @@ -25,4 +26,4 @@ This snippet of code will fetch the 10 most recent posts that are featured.
//output featured posts here

endwhile; endif;
?>`
?>``
9 changes: 5 additions & 4 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The plugin displays a checkbox in the publish meta box to feature a post. The ch

When a post is designated as featured:

* It receives 'featured' and 'featured-{$posttype}' classes via the post_class filter.
* It receives 'featured' and `featured-{$posttype}` classes via the post_class filter.
* Shows featured posts as such in the post type's admin screen
* Assigns a post a hidden taxonomy term (featured) that can easily be queried.

Expand All @@ -36,7 +36,8 @@ This is not the same as sticky posts. Sticky functionality can only be applied t
= How do I find just my featured posts? =

This snippet of code will fetch the 10 most recent posts that are featured.
`<?php

``<?php
$featured_posts = new WP_Query( array(
'post_type' => 'post',
'posts_per_page' => 10,
Expand All @@ -54,13 +55,13 @@ This snippet of code will fetch the 10 most recent posts that are featured.
//output featured posts here

endwhile; endif;
?>`
?>``

== Screenshots ==

1. The settings page.
2. Options on the edit screen
3. Markup example when using post_class();
3. Markup example when using `post_class();`
4. Shows featured posts in post edit tables.

== Changelog ==
Expand Down

0 comments on commit 72b5208

Please sign in to comment.