From 327cbc834451698df2e584b0cf5bba1024e51568 Mon Sep 17 00:00:00 2001 From: webmech Date: Tue, 23 Oct 2018 14:42:38 -0400 Subject: [PATCH] docs(readme): update usage for addWords in docs --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ea436ef..a196ab1 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,12 @@ var filter = new Filter({ replaceRegex: /[A-Za-z0-9가-힣_]/g }); ```js var filter = new Filter(); +filter.addWords('some', 'bad', 'word'); + +filter.clean("some bad word!") //**** *** ****! + +//or use an array using the spread operator + var newBadWords = ['some', 'bad', 'word']; filter.addWords(...newBadWords); @@ -73,7 +79,7 @@ filter.clean('hell this wont clean anything'); //hell this wont clean anything ```js let filter = new Filter(); -filter.removeWords('hells'); +filter.removeWords('hells' 'sadist'); filter.clean("some hells word!"); //some hells word!