From 2b4968e4f09a0646c87ba2a6d4179d84f30bd1bf Mon Sep 17 00:00:00 2001 From: Nathachai Thongniran Date: Mon, 7 Nov 2022 10:25:14 +0700 Subject: [PATCH] docs(readme): update "Example usage for npm" and "CMD" sections --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c5000a6..cd39681 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,15 @@ var filter = require('leo-profanity'); // output: I have ****, etc. filter.clean('I have boob, etc.'); + +// replace current dictionary with the french +filter.loadDictionary('fr'); + +// create new dictionary +filter.addDictionary('th', ['หนึ่ง', 'สอง', 'สาม', 'สี่', 'ห้า']) ``` -See more here [LeoProfanity.clean](https://jojoee.github.io/leo-profanity/doc/LeoProfanity.html#.clean) +See more here [LeoProfanity - Documentation](https://jojoee.github.io/leo-profanity/doc/LeoProfanity.html) ## Algorithm @@ -131,6 +137,11 @@ Disadvantage: ## CMD ``` +npm run test.watch +npm run validate +npm run doc.generate + +# test npm publish npm publish --dry-run ```