<commit_before># Banned Words

## Installation

Add this line in your Gemfile:

gem "banned_words"

## Usage

```ruby
BannedWords.create!("dog")
phrase = "The quick brown fox jumps over the lazy dog"
BannedWords.mask(phrase)
=> "The quick brown fox jumps over the lazy *Buzz*"

# Another example:
phrase = "Red d-o-g"
BannedWords.mask(phrase)
=> "Red *Buzz*"
```<commit_msg>small updates to the readme<commit_after># Banned Words
Detects and masks banned words within a text

## Installation

Add this line in your Gemfile:
```ruby
gem 'banned_words'
```

## Usage

```ruby
BannedWords.create!('dog')
phrase = 'The quick brown fox jumps over the lazy dog'
BannedWords.mask(phrase)
> 'The quick brown fox jumps over the lazy *Buzz*'

# Another example:
phrase = 'Red d-o-g'
BannedWords.mask(phrase)
> 'Red *Buzz*'
```
{'fraction_non_alphanumeric': 0.12990196078431374, 'fraction_numerical': 0.0, 'mean_word_length': 5.007352941176471, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6016864', 'n_tokens_mistral': 305, 'n_tokens_neox': 277, 'n_words': 99}