Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.49 KB

README.md

File metadata and controls

59 lines (38 loc) · 1.49 KB
Raw

npm version code style: prettier

SPR_Censorify_Example

Enhance content integrity using CustomCensorify: a JavaScript module. Efficiently replace sensitive words for respectful communication. Code and example included.

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
9.8.1
v20.5.0

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

Start with cloning this repo on your local machine:

$ git clone https://github.com/SPRHackz/spr_censorify_Example.git
$ cd spr_censorify_Example

To install and set up the library, run:

$ npm install sprhackz-censorify

Or if you prefer using Yarn:

$ yarn add sprhackz-censorify

Usage

Serving the app

$ npm start

Authors