Initial commit

sanitize special characters
support for custom reg matching pattern
Create LICENSE.md
Update README.md
added condition check

Author: pcpratheesh

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build
+# this will work for every push
+on: ["push"]
+
+jobs:
+  build:
+      runs-on: ubuntu-latest
+      steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.15
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Test
+        run: go test -v ./...
+      

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+name: Create Release
+
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          draft: false
+          prerelease: false

.gitignore

@@ -0,0 +1,15 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 PRATHEESH PC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,49 @@
+[![Create Release](https://github.com/pcpratheesh/go-censorword/actions/workflows/release.yml/badge.svg)](https://github.com/pcpratheesh/go-censorword/actions/workflows/release.yml)
+
+# go-censorword
+
+go-censorword is a lightweight library for detecting profanities in Go string.
+
+
+## Installation
+```
+    go get -u github.com/pcpratheesh/go-censorword
+```
+## Usage
+```go
+import (
+	"github.com/pcpratheesh/go-censorword"
+)
+```
+
+## In working
+go-censorword package uses a censorWord [here](censor/censor.go) list to check the profanities. 
+Als we have provided an option to override this list of contents by using
+```go
+CustomCensorList() 
+```
+You can provide your own list to search and replace the profanities
+
+## Example
+```go
+var detector = gocensorword.NewDetector().SetCensorReplaceChar("*")
+detector.CustomCensorList([]string{
+    "bad", "word","one",
+})
+```
+## Example
+```go
+detector := NewDetector().SetCensorReplaceChar("*")
+
+resultString, err := detector.CensorWord(inputString)
+
+if err != nil {
+    panic(err)
+}
+```
+
+
+In the future, we should implement the following points
+- Support for other language profanities
+- All words having repeated characters more than twice (eg : fuck -> fuuuuuck)
+- Should remove word match conditions (eg :-> fucker, fucking..etc)