Skip to content

Commit

Permalink
Set up README for WordPress.org plugin repository
Browse files Browse the repository at this point in the history
  • Loading branch information
joshbetz committed Jul 10, 2012
1 parent 7092b3d commit fbee987
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 14 deletions.
16 changes: 2 additions & 14 deletions README.md
Expand Up @@ -6,18 +6,6 @@ A WordPress plugin that lets you manage users across all your sites from one pla
Filters Filters
----- -----


* `pre_user_login` - (same as core) applied to the user's URL prior to saving in the database. * `bulk_user_management_blogs` - array of blogs to limit against.
* `bulk_user_management_limit_blogs` - array of blogs to limit against.
* `bulk_user_management_parent_page` - sets parent page. * `bulk_user_management_parent_page` - sets parent page.

* `bulk_user_management_admin_users` - array of users that the plugin is active for
Actions
-------

* `bulk_user_management_invite_form` - prints a form to invite users
* `bulk_user_management_invite` - replace invite method for standard invite form
* `$blogids` - (array) IDs of blogs to invite to
* `$emails` - (array) email addresses to invite
* `$users` - (array) usernames to invite
* `$role` - (string) role to set users on specified blogs
* `$message` - (string) custom message for invite email
* `$noconfirmation` - (bool) don't send confirmation email on true
38 changes: 38 additions & 0 deletions readme.txt
@@ -0,0 +1,38 @@
=== Bulk User Management ===
Contributors: automattic, betzster, danielbachhuber
Tags:
Requires at least: 3.4
Tested up to: 3.4.1
Stable tag: 1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

A plugin that lets you manage users across all your sites from one place on a multisite install.

== Description ==

A plugin that lets you manage users across all your sites from one place on a multisite install.

If you'd like to check out the code and contribute, [join us on GitHub](https://github.com/Automattic/bulk-user-management). Pull requests are more than welcome!

== Installation ==

1. Upload the `bulk-user-management` folder to your plugins directory (e.g. `/wp-content/plugins/`)
2. Activate the plugin through the 'Plugins' menu in WordPress

The following filters will let you customize the plugin:

* `bulk_user_management_blogs` - array of sites that can be managed
* `bulk_user_management_parent_page` - sets parent page
* `bulk_user_management_admin_users` - array of users that the plugin is active for

== Frequently Asked Questions ==

= Why are there no FAQs? =

Because you haven't asked one yet.

== Changelog ==

= 1.0 =
* Initial Release

0 comments on commit fbee987

Please sign in to comment.