Changeset 8384

Timestamp:

03/17/2007 10:17:13 AM (19 years ago)

Author:

AnkurKothari

Message:

Updated readme

Location:

gregarious/trunk

Files:

• Readme.txt (modified) (1 diff)
• readme.txt (added)

gregarious/trunk/Readme.txt

@@ -1 @@
-Plugin Name: Gregarious
-Version: 2.0 RC 2
-Plugin URI: http://dev.lipidity.com/feature/wp-plugin-gregarious
-Author: Ankur Kothari
-Author URI: http://dev.lipidity.com/
-Author Email: admin@lipidity.com
+=== Gregarious ===
+Contributors: AnkurKothari
+Donate link: http://dev.lipidity.com/feature/wp-plugin-gregarious
+Tags: social, share this, digg, del.icio.us
+Requires at least: 1.5
+Tested up to: 2.1
+Stable tag: trunk
 
-Now uses the brand spanking new Digg API! See http://digg.com/tools/integrate
+Gregarious is the ultimate social bookmarking plugin integrating all the major sites with an AJAX interface.
 
-Complete documentation is coming. Be patient, you must, young padawan.
+== Description ==
 
-THIS IS A WORK IN PROGRESS. IT'S STILL BEING WRITTEN. IF YOU DO COME ACROSS A BUG, IT'S HIGHLY LIKELY THAT YOU'RE DOING SOMETHING WEIRD, YOU DON'T KNOW HOW TO DO SOMETHING (Bear with me while the documentation is being written), OR YOUR SETUP IS BORKED. CONTACT ANKUR ~IMMEDIATELY~ AT http://dev.lipidity.com/feature/wp-plugin-gregarious OR EMAIL TO ankur@lipidity.com. YES, I WILL HELP YOU FIX UP YOUR SITE...
+*Gregarious* is a **social bookmarking** plugin that integrates the new Digg API and Alex King's Share This plugin, as well as the Reddit button and Feedburner's Feedflare into one powerful, easy to use package. The AJAX interface makes customization a breeze, and the options put you in control. Gregarious works on a module based system, which means that it can have as many or as little features as you like. Modules available include:
+* Digg button
+* Digg stats (w/ LiveSearch)
+* Share This
+* Reddit button
+* Feedburner FeedFlare
+* Update checking
+* PostBadge
+* AJAX updating
 
-If you would like to REQUEST A FEATURE then please contact me via the above address (if you're lazy, ankur@lipidity.com). And YES, I do overuse capital letters.
+Everything can be configured from the options page. There are absolutely **zero template edits** required.
+You have the option to choose which modules are enabled, and in turn, how many features you'd like to have.
 
-//===========================================================================
-// INSTALLATION
-//===========================================================================
+The plugin has been written with **usablility** and **performance** in mind, so it shouldn't have any adverse affects on the speed of your blog while providing you with the most **comprehensive** social bookmarking system *ever*.
 
-Copy the "gregarious" plugin to the wordpress plugins folder, then and activate the plugin from the administration menu. (If you rename the folder it won't work. It must be called "gregarious")
+== Installation ==
 
-CHMOD akst.css and akst.js to 777 (Required for adding social sites to "Share This")
+Installing Gregarious into your WordPress blog is extremely straightforward.
 
-Configure everything from the admin options panel, or use the template tags.
+1. Download and unzip `gregarious`
+2. Upload the `gregarious` folder to the `/wp-content/plugins/` directory
+3. Activate the plugin through the 'Plugins' menu in WordPress
+4. Configure your settings from the Gregarious options page
+5. Make sure everything's working smoothly!
 
-//===========================================================================
-// ADDING SOCIAL SITES TO SHARE THIS
-//===========================================================================
+== Frequently Asked Questions ==
 
-Under the 'Share This' tab, you'll find an setting labelled 'Configure Social Sites'. Click it, and the complete list of social bookmarking sites will show. Here, you can add, remove, or rearrange the sites you want to show in your 'Share This' dialog.
+= Gregarious is not installing properly and causing an error / blank screen / warning on my blog. How do I fix it? =
 
-The '{url}' tag is required in the URL you provide and is replaced with the permalink of the post that the Share This link is shown on.
-The '{title}' tag is optional in the URL, and is replaced with a slightly sanitized version of the post title.
+In most cases, installing Gregarious should be painless. However occasionally problems do occur. If you do get an error, perform the following:
 
-To associate icons with social sites that you add, upload a gif image to /wp-content/plugins/gregarious/share-this. The name of the image must be the name of the site as displayed in the header row exactly. Future versions will see the ability to change the URL from the options panel without having to go through these steps.
+* Make sure all the files have been uploaded correctly
+* Ensure that the uploaded folder is named `gregarious`
+* Check that you have activated some of the modules in the options page and reset the Gregarious' options
 
-//===========================================================================
-// TEMPLATE TAGS
-//===========================================================================
+If gone through the preceding points to no avail, contact the developer for assistance by posting a comment at (http://dev.lipidity.com/feature/wp-plugin-gregarious "the official website").
 
-digg_button()
+= Gregarious is installed fine, but the options page doesn't work properly =
 
-share_this()
+Gregarious requires a modern browser such as FireFox to ensure that the options page functions correctly, however up-to-date versions of Internet Explorer should work as well.
 
-reddit_button()
+If you notice the following, make sure you have correctly uploaded all the files.
+* Your browser shows javascript errors
+* Clicking on the options or tabs does nothing
+* Nothing works when clicked on
 
-post_badge()
+If nothing helps, contact the developer for assistance by posting a comment at (http://dev.lipidity.com/feature/wp-plugin-gregarious "the official website").
 
-dugg_posts()
+= Why am I getting a Share This page instead of popup? =
 
-====
+The Share This popup requires a file called prototype.js to be included in the website. If you're running WordPress 2.0 or below, you will need to add a script tag with the src to prototype.js in the head section of your template.
 
-//===========================================================================
-// DOCUMENTATION
-//===========================================================================
+If prototype.js is included and / or you're running WordPress 2.1 or above, check that prototype isn't being included multiple times by other plugins.
 
-http://dev.lipidity.com/docs/
+When all else fails, we're still here to help. Contact the developer for assistance by posting a comment at (http://dev.lipidity.com/feature/wp-plugin-gregarious "the official website").
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+