- AAProfanityFilter
- Description
- Demonstration
- Requirements
- Installation
- CocoaPods
- Carthage
- Manual Installation
- Getting Started
- Contributions & License
#AAProfanityFilter
##Description
AAProfanityFilter is a profanity filter for images written Swift. Its a lightweight framework that can detect the inappropriation in Strings with a single line of code.
##Demonstration
To run the example project, clone the repo, and run pod install from the Example directory first.
##Requirements
- iOS 9.0+
- Xcode 9.0+
- Swift 4.2+
AAProfanityFilter can be installed using CocoaPods, Carthage, or manually.
##CocoaPods
AAProfanityFilter is available through CocoaPods. To install CocoaPods, run:
$ gem install cocoapods
Then create a Podfile with the following contents:
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!
target '<Your Target Name>' do
pod 'AAProfanityFilter'
end
Finally, run the following command to install it:
$ pod install
##Carthage
To install Carthage, run (using Homebrew):
$ brew update
$ brew install carthage
Then add the following line to your Cartfile:
github "EngrAhsanAli/AAProfanityFilter" "master"
Then import the library in all files where you use it:
import AAProfanityFilter##Manual Installation
If you prefer not to use either of the above mentioned dependency managers, you can integrate AAProfanityFilter into your project manually by adding the files contained in the Classes folder to your project.
##Detect the Content
let ff: String = "Some String"
print(ff.aa_profanityFiltered())
}#Contributions & License
AAProfanityFilter is available under the MIT license. See the LICENSE file for more info.
Pull requests are welcome! The best contributions will consist of substitutions or configurations for classes/methods known to block the main thread during a typical app lifecycle.
I would love to know if you are using AAProfanityFilter in your app, send an email to Engr. Ahsan Ali