Plugin Directory

Changeset 929907


Ignore:
Timestamp:
06/10/2014 08:14:58 PM (12 years ago)
Author:
AstrizStudios
Message:

Updated the readme.txt to have clearer explanation on how to use the service and plugin.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • profanityblocker-profanity-filter/trunk/readme.txt

    r929503 r929907  
    1 === ProfanityBlocker - Profanity Filter ===
     1=== ProfanityBlocker - Profanity Filter ===
    22Contributors: BaneD
    33Tags: profanity filter, profane, swearing filter, content filter, phonetic filter, word abuse filter, buddypress filter
    44Requires at least: 2.7
    55Tested up to: 3.9.1
    6 Stable tag: 1.0
     6Stable tag: trunk
    77
    88ProfanityBlocker is a cloud based service that scans for profane (swearing/abusive) words - giving you greater control of allowed text on your site
     
    1212= What is ProfanityBlocker =
    1313ProfanityBlocker is a highly advanced system with a clean and simple interface shown to the end user - you! We made the system easily configurable over our plugin and the control panel on our website.
    14 With our plugin you have content instantly, without any fuss automatically moderated for any bad words such as profanity, swearing, or abusive language. You can also have your personal blacklist. Just login to our control panel and add the word. We’ll do the rest. The system will update our network with your change.
     14
     15With our plugin you have content instantly, without any fuss automatically moderated for any bad words such as profanity, swearing, or abusive language. You can also have your personal blacklist. Just login to our control panel and add the word. We’ll do the rest. The system will update our network with your change.
     16
    1517= Why ProfanityBlocker is here =
    16 After running a few communities, we needed a filtering service that is both simple and advanced. We weren’t spoilt for rich choices when the company started looking into filters, at least the ones that would scan the text without a need to type in all of the variations of the words that members of our communities used - to say what they wanted, even if means hurting others.
     18After running a few communities, we needed a filtering service that is both simple and advanced. We weren’t spoilt for rich choices when the company started looking into filters, at least the ones that would scan the text without a need to type in all of the variations of the words that members of our communities used - to say what they wanted, even if means hurting others.
     19
    1720After testing several options, we found that there was either a question of speed, quality or both and this has resulted in an advanced system that you can see today.
    1821This system is being used by the plugin and we have decided that our first plugin should be for the WordPress community.
     22
     23This is of course not only limited to WordPress, but it will filter your texts even if you are running BuddyPress or bbPress (with bbPress being at the start of the implementation).
    1924
    2025Do check the screenshots for more..
     
    27321. Upload `profanityblocker-profanity-filter` directory to the `/wp-content/plugins/` directory
    28331. Activate the plugin through the 'Plugins' menu in WordPress
     341. Visit (http://www.profanity-blocker.com) to register and create a license
     351. Return to your WordPress site
    29361. Go to the Settings->ProfanityBlocker Management page and set the key that you got from our website
    30371. Check the options you like to enable and save
     
    3239
    3340= Automated Installation =
    34 1. Go to the 'Plugins' menu in WordPress and click on Search.
    35 1. Search for our plugin `ProfanityBlocker - ProfanityBlocker` and click install
     411. Go to the 'Plugins' menu in WordPress and click on Search
     421. Search for our plugin `ProfanityBlocker – Profanity Filter` and click install
    36431. Click to activate the plugin
     441. Visit (http://www.profanity-blocker.com) to register and create a license
     451. Return to your WordPress site
    37461. Go to the Settings->ProfanityBlocker Management page and set the key that you got from our website
    38 1. Check the options you like to enable and save
     471. Check the options you’d like to enable and save
    39481. Let it work for you
    4049
     
    5564Yes, our plugin only looks to avoid filtering on a draft. As soon as it is changed into something else (for example gets published), it is sent for filtering.
    5665
     66= Does this plugin work for WordPress core only? =
     67No. Our plugin is filtering with WordPress core elements, but also BuddyPress elements and some bbPress elements. We are however planning to expand bbPress coverage so that we can filter any part of the system that might be a problem for your community.
     68
     69= I found a bug, do you care? =
     70Yes of course! We are at beta stage for now, so we know that there are some bugs that are likely to pop up and as such we are interested in hearing any possible issues that you might have because of our plugin in order to help you out in a fast manner, but also to others that opt for our plugin. Just go to support tab and let us know more, or send us an email to support/@t\profanity-blocker.com
    5771
    5872== Screenshots ==
     
    6983== Changelog ==
    7084
     85= 1.1 =
     86* Fixed the issue where a class was not initialized before being read for some reason.
     87
    7188= 1.0 =
    7289* Filtering using array submissions
    7390* code separation and minimization (refactoring)
    7491* Errors reporting option
     92
     93== How to use it ==
     94You will need to get a license key from our website. To do that you will need to go here: [Profanity-Blocker.com](http://www.profanity-blocker.com/ “Profanity-Blocker.com - Your very own Profanity Blocker”).
     95
     96After you go there either log in if you are already registered or signup by following the instructions on the site. You will get a free 15 days trial Premium package right after subscribing.
     97
     98The payment agreement is set right away after you create an account for your domain, but as you are shown, you are not billed until the trial license expires.
     99
     100Once you set the agreement you will get your account activated and can start using it straight away.
     101
     102= What will you get =
     103You get a Premium package as a trial (you can opt for Basic or Enterprise if you so choose, but the payment is then made the very next day). This means that you get the advanced filtering plus the email filtering, phone numbers filtering and the links filtering for 15 free days - that is if you select them in your plugin.
     104
     105= Quick links =
     106To register go here [Profanity-Blocker.com signup](http://www.profanity-blocker.com/user/register “Create your own Profanity Blocker account”).
     107To check out our pricing page, go here: [Profanity-Blocker.com pricing]( http://www.profanity-
Note: See TracChangeset for help on using the changeset viewer.