Skip to content

Commit

Permalink
Updated readme.txt and added readme.md for Github
Browse files Browse the repository at this point in the history
  • Loading branch information
JLeuze committed Apr 21, 2012
1 parent 4ab3731 commit 61c7db4
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 9 deletions.
2 changes: 1 addition & 1 deletion meteor-slides-plugin.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php
/*
Plugin Name: Meteor Slides
Description: Meteor Slides makes it simple to create slideshows with WordPress by adding a custom post type for slides.
Description: Easily create responsive slideshows with WordPress that are mobile friendly and simple to customize.
Plugin URI: http://www.jleuze.com/plugins/meteor-slides
Author: Josh Leuze
Author URI: http://www.jleuze.com/
Expand Down
43 changes: 43 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Meteor Slides
==========================

Meteor Slides makes it simple to create slideshows and publish them with a shortcode, widget, or template tag. The slideshows scale with responsive and fluid themes to fit any device and have touch support. Powered by [jQuery Cycle](http://jquery.malsup.com/cycle/) with over twenty transition styles to choose from.

Meteor Slides Homepage
---------------

[Visit this plugin's homepage](http://www.jleuze.com/plugins/meteor-slides/) for documentation, tutorials, and additional videos.

= Features =
---------------

* *Easy integration:* Add the slideshow to your site using a template tag, shortcode, or widget.
* *Mobile Friendly:* Scales to fit any device, supports touch navigation for mobiles and tablets.
* *Multiple Slideshows:* Organize your slides into multiple slideshows.
* *Slideshow settings page:* Control the slide height and width, the number of slides, the slideshow speed and transition style, and the type of navigation.
* *Slideshow metadata:* Customize individual slideshows or configure more [jQuery Cycle options](http://jquery.malsup.com/cycle/options.html "jQuery Cycle Plugin") with the [MetaData jQuery Plugin](http://plugins.jquery.com/project/metadata "MetaData jQuery Plugin").
* *Slideshow transition styles:* blindX, blindY, blindZ, cover, curtainX, curtainY, fade, fadeZoom, growX, growY, none, scrollUp, scrollDown, scrollLeft, scrollRight, scrollHorz, scrollVert, slideX, slideY, turnUp, turnDown, turnLeft, turnRight, uncover, wipe, zoom.
* *Slideshow navigation:* Optional previous/next and/or paged slide navigation.
* *Multiple languages:* Belarusian, Chinese, Czech, Danish, Dutch, English, French, German, Hebrew, Indonesian, Italian, Japanese, Persian, Polish, Portuguese, Portuguese (Brazilian), Romanian, Russian, Spanish, Swedish, Turkish.

Installation
==========================

1. Upload the *meteor-slides* folder to your */wp-content/plugins/* directory or go to Plugins -> Add New from your Dashboard in WordPress.
2. Activate the plugin through the Plugins menu in WordPress
3. Use the Settings link or go to Slides -> Settings to access the Meteor Slides settings.

Configure Slideshow
---------------

_Before adding any slides, enter the slide height and width in the settings so the slides are the correct dimensions._

Add Slideshow
---------------

Use ```php<?php if ( function_exists( 'meteor_slideshow' ) ) { meteor_slideshow(); } ?>``` to add this slideshow to your theme, use ```[meteor_slideshow]``` to add it to your Post or Page content, or use the Meteor Slides Widget to add it to a sidebar.

Meteor Slides Documentation
---------------

Check out the [Meteor Slides Documentation](http://www.jleuze.com/plugins/meteor-slides/installation/) for more information on using Meteor Slides, adding slideshows, using metadata, and advanced customization.
17 changes: 9 additions & 8 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
=== Meteor Slides ===
Contributors: jleuze
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=mail%40jleuze%2ecom&item_name=Meteor%20Slides%20Donation&no_shipping=0&no_note=1&tax=0&currency_code=USD&lc=US&bn=PP%2dDonationsBF&charset=UTF%2d8
Tags: slide, slides, slider, slideshow, image, custom post types, jquery
Tags: custom post types, image, jquery, responsive, slide, slider, slides, slideshow
Requires at least: 3.3
Tested up to: 3.3.1
Tested up to: 3.3.2
Stable tag: 1.5

Meteor Slides makes it simple to create slideshows with WordPress by adding a custom post type for slides.
Easily create responsive slideshows with WordPress that are mobile friendly and simple to customize.

== Description ==

Easily create slideshows and publish them with a shortcode or widget. The slideshows are powered by [jQuery Cycle](http://jquery.malsup.com/cycle/) and have over twenty transition styles to choose from.
Meteor Slides makes it simple to create slideshows and publish them with a shortcode, widget, or template tag. The slideshows scale with responsive and fluid themes to fit any device and have touch support. Powered by [jQuery Cycle](http://jquery.malsup.com/cycle/) with over twenty transition styles to choose from.

= Meteor Slides Homepage =

Expand All @@ -25,6 +25,7 @@ This screencast shows some of the plugin's features, such as different transitio
= Features =

* **Easy integration:** Add the slideshow to your site using a template tag, shortcode, or widget.
* **Mobile Friendly:** Scales to fit any device, supports touch navigation for mobiles and tablets.
* **Multiple Slideshows:** Organize your slides into multiple slideshows.
* **Slideshow settings page:** Control the slide height and width, the number of slides, the slideshow speed and transition style, and the type of navigation.
* **Slideshow metadata:** Customize individual slideshows or configure more [jQuery Cycle options](http://jquery.malsup.com/cycle/options.html "jQuery Cycle Plugin") with the [MetaData jQuery Plugin](http://plugins.jquery.com/project/metadata "MetaData jQuery Plugin").
Expand Down Expand Up @@ -55,6 +56,10 @@ Check out the [Meteor Slides Documentation](http://www.jleuze.com/plugins/meteor

== Frequently Asked Questions ==

= Meteor Slides is awesome, what can I do to help? =

You can help right on this page by rating the plugin or voting for its compatibility with the latest version of WordPress. Blog about Meteor Slides to get the word out, or [visit my blog](http://www.jleuze.com/ "JLeuze.com") to post feedback or just say hi. You could also [translate Meteor Slides](http://www.jleuze.com/plugins/meteor-slides/languages/ "Meteor Slides Languages") into another language or [make a donation](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=mail%40jleuze%2ecom&item_name=Meteor%20Slides%20Donation&no_shipping=0&no_note=1&tax=0&currency_code=USD&lc=US&bn=PP%2dDonationsBF&charset=UTF%2d8 "Donate").

= I add a slide, save or publish it, and then it's missing or not found, what gives? =

Every post needs a title, make sure to give your slide a title where is says "Enter title here". This title is mostly used just to label them in the backend, but it will also be used as the title of your link if you add a link.
Expand Down Expand Up @@ -89,10 +94,6 @@ It's also possible that a script in your theme or another plugin is using the "$

If the Slides menu is missing, you probably have the [Members](http://wordpress.org/extend/plugins/members/ "Members plugin") plugin activated. Meteor Slides supports the Members plugin, so if you have them both running you can use Members to choose which roles can manage the slides or slideshow settings. Take a look at [this blog post](http://www.jleuze.com/using-the-members-plugin-with-meteor-slides/ "Using the Members plugin with Meteor Slides") for more info on using these plugins together.

= Meteor Slides is awesome, what can I do to help? =

You can help right on this page by rating the plugin or voting for its compatibility with the latest version of WordPress. Blog about Meteor Slides to get the word out, or [visit my blog](http://www.jleuze.com/ "JLeuze.com") to post feedback or just say hi. You could also [translate Meteor Slides](http://www.jleuze.com/plugins/meteor-slides/languages/ "Meteor Slides Languages") into another language or [make a donation](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=mail%40jleuze%2ecom&item_name=Meteor%20Slides%20Donation&no_shipping=0&no_note=1&tax=0&currency_code=USD&lc=US&bn=PP%2dDonationsBF&charset=UTF%2d8 "Donate").

*Please [post any questions or problems](http://wordpress.org/tags/meteor-slides?forum_id=10#postform "Post a question or problem in the forums") in the WordPress.org support forums.*

== Screenshots ==
Expand Down

0 comments on commit 61c7db4

Please sign in to comment.