Skip to content

Commit 6e217e3

Browse files
authored
[CF] updated readme.md
1 parent ff07939 commit 6e217e3

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
<!-- a comment-->
2-
## **jQuery.profanityFilter plug-in** ##
1+
## jQuery.profanityFilter plug-in ##
32

43
[demo](https://chaseflorell.github.io/jQuery.ProfanityFilter/demo/)
54

@@ -10,49 +9,49 @@ This was built in order to allow users to "Opt-in" to profanity filtering, and o
109
***Obvious warning:*** *The `swearWord` lists as well as code examples contain material that many will find offensive. (But that's the point!)*
1110
*note: localization support provided by shutterstock's [List of Dirty, Naughty, Obscene, and Otherwise Bad Words](https://github.com/shutterstock/List-of-Dirty-Naughty-Obscene-and-Otherwise-Bad-Words)*
1211

13-
###**Usage:**###
12+
### Usage: ###
1413

1514
---
1615

17-
Option 1:
16+
**Option 1:**
1817

1918
// Filter the word "shit" every time it shows up inside the element "SomeElement"
2019
$('#SomeElement').profanityFilter({
2120
customSwears: ['shit']
2221
});
2322

24-
Option 2:
23+
**Option 2:**
2524

2625
// Filter an external array of words on the entire document
2726
$(document).profanityFilter({
2827
externalSwears: '/Path/To/Json/Swears/'
2928
});
3029

31-
Option 3:
30+
**Option 3:**
3231

3332
// Change the replacement character from an astrisk (*) to a pound sign (#)
3433
$('#SomeElement').profanityFilter({
3534
externalSwears: '/Path/To/Json/Swears/',
3635
replaceWith: '#'
3736
});
3837

39-
Option 4:
38+
**Option 4:**
4039

4140
// Change the replacement from astrisks (*) to random words
4241
$('#SomeElement').profanityFilter({
4342
externalSwears: '/Path/To/Json/Swears/',
4443
replaceWith: ['fiddle', 'fun', 'stupendous']
4544
});
4645

47-
Option 5:
46+
**Option 5:**
4847

4948
// Combine an externl Swear list with a custom list (don't worry, we'll remove duplicates)
5049
$('#SomeElement').profanityFilter({
5150
customSwears: ['monkeyass'],
5251
externalSwears: '/Path/To/Json/Swears/'
5352
});
5453

55-
Option 6:
54+
**Option 6:**
5655

5756
// Don't filter anything. Useful in conjunction with the profaneText callback (which only
5857
// fires when profanity exists).
@@ -67,27 +66,27 @@ Option 6:
6766
});
6867

6968

70-
###**Get It:**###
69+
### Get It: ###
7170

7271
- bower `> bower install jQuery.ProfanityFilter`
7372

74-
###**Bug Tracker:**###
73+
### Bug Tracker: ###
7574

7675
---
7776

7877
Find a bug? Please create an issue here on GitHub!
7978
https://github.com/ChaseFlorell/jQuery.profanityFilter/issues
8079

8180

82-
###**Dependencies**###
81+
### Dependencies ###
8382

8483
----
8584

8685
This plugin requires:
8786

8887
- [jQuery](http://jquery.com/) (tested 1.7.1)
8988

90-
###**Author:**###
89+
### Author: ###
9190

9291
---
9392

@@ -96,7 +95,7 @@ Chase Florell
9695
- http://github.com/ChaseFlorell
9796
- http://twitter.com/ChaseFlorell
9897

99-
###**Copyright and License**###
98+
### Copyright and License ###
10099

101100
---
102101

0 commit comments

Comments
 (0)