Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added proper README for Github

  • Loading branch information...
commit fc5fab333ce54354a2ebe7af469da8b8846d1f6d 1 parent 238f792
@picandocodigo authored
Showing with 32 additions and 2 deletions.
  1. +0 −1  README.markdown
  2. +31 −0 README.markdown
  3. +1 −1  readme.txt
View
1  README.markdown
View
31 README.markdown
@@ -0,0 +1,31 @@
+# List Category Posts
+
+List Category Posts is a **[WordPress](http://wordpress.org) plugin** that allows you to list posts from a category into a post/page using the [catlist] shortcode. Please visit the [plugin's page on WordPress.org](http://wordpress.org/extend/plugins/list-category-posts/) to find out more.
+
+The shortcode accepts a category name or id, the order in which you want the posts to display, and the number of posts to display. You can also display the post author, date, excerpt, custom field values, even the content! The [catlist] shortcode can be used as many times as needed with different arguments on each post/page.
+
+Great to use WordPress as a CMS, and create pages with several categories posts.
+
+**Widget**: It includes a widget which works pretty much the same as the plugin. Just add as many widgets as you want, and select all the available options from the Appearence > Widgets page.
+
+Please, read the information on [Other Notes](http://wordpress.org/extend/plugins/list-category-posts/other_notes/) and [Changelog](http://wordpress.org/extend/plugins/list-category-posts/changelog/) to be aware of new functionality, and improvements to the plugin.
+
+##Usage
+
+`[catlist argument1=value1 argument2=value2]`
+
+##Support the plugin
+
+If you've found the plugin useful, consider making a [donation via PayPal](http://picandocodigo.net/programacion/wordpress/list-category-posts-wordpress-plugin-english/ "Donate via PayPal") or visit my Amazon Wishlist for [books](http://www.amazon.com/gp/registry/wishlist/2HU1JYOF7DX5Q/ref=wl_web "Amazon Wishlist") or [comic books](http://www.amazon.com/registry/wishlist/1LVYAOJAZQOI0/ref=cm_wl_rlist_go_o) :).
+
+##Development
+
+I've moved the development to [GitHub](https://github.com/picandocodigo/List-Category-Posts). Fork it, code, make a pull request, suggest improvements, etc. over there. I dream of the day all of the WordPress plugins will be hosted on Github :)
+
+
+##Installation
+
+* Upload listcat directory into your `wp-content/plugins/` directory.
+* Login to your WordPress Admin menu, go to Plugins, and activate it.
+* You can find the List Category Posts widget in the *Appearence > Widgets* section on your WordPress Dashboard.
+* If you want to customize the way the plugin displays the information, check the section on Templates on this documentation.
View
2  readme.txt
@@ -36,7 +36,7 @@ I've moved the development to [GitHub](https://github.com/picandocodigo/List-Cat
==Installation==
-* Upload listcat directory into you wp-content/plugins/ directory.
+* Upload listcat directory into your wp-content/plugins/ directory.
* Login to your WordPress Admin menu, go to Plugins, and activate it.
* You can find the List Category Posts widget in the Appearence > Widgets section on your WordPress Dashboard.
* If you want to customize the way the plugin displays the information, check the section on Templates on this documentation.

0 comments on commit fc5fab3

Please sign in to comment.
Something went wrong with that request. Please try again.