Skip to content

Commit

Permalink
Improved 'README.md'
Browse files Browse the repository at this point in the history
  • Loading branch information
jtsimoes authored Jan 13, 2019
1 parent 2fa0871 commit 289edd8
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,15 @@ A simple plugin NodeBB that displays a confirm box with a 'not safe for work' wa

* Go to your NodeBB root;
* Stop your NodeBB using `./nodebb stop`;
* Run `npm install jtsimoes/nodebb-plugin-nsfw`;
* Run `npm install jtsimoes/nodebb-plugin-nsfw` or copy this repository into `node_modules` folder;
* Start your NodeBB using `./nodebb start`;
* Enable the plugin on the ACP plugin page;
* Restart and rebuild your NodeBB;
* Done.

## Config :

The default category ID is 28. I will make this customizable in the future if you need to change it, for now it's necessary to fork this repository and change the variable `nsfwCategoryId` in the file `main.js` itself.
Feel free to change the messages and the actions that the confirm buttons does.
**The default category ID is 28.** I will make this customizable in the future if you need to change it, for now it's necessary to fork this repository and change the variable `nsfwCategoryId` in the file `main.js` itself. Feel free to also change the messages and the actions that the confirm buttons does.

## To-Do List :

Expand Down

0 comments on commit 289edd8

Please sign in to comment.