diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -12,6 +12,119 @@ Eros is still in development, and is not ready to be actually used. If you would like to contribute, please do. +At the time of this writing, I'm at version 0.3 (see +[here](https://github.com/pharpend/eros/releases)) for the current release. + +See the [API documentation on Hackage](http://hackage.haskell.org/package/eros) +if you want to learn how to use the library. + +# Usage - v.0.3.0.1 + +This is a usage guide for version 0.3.0.1. There will be more up-to-date usage +guides as more versions come, hopefully. + +To install, run `cabal install eros`. + +## `erosc` + +The only way to interact with the library, for the time being is through the +client I built, `erosc`. It accepts input in Javascript Object Notation (JSON) +through `stdin`. + +Here is the schema for the input: + +```json +{ + "name": "erosc-input", + "type": "object", + "description": "The schema for the input to erosc.", + "properties": { + "text": { + "type": "string", + "description": "The text you want to be checked against the phraselists.", + "required": true + }, + "eros-lists": { + "type": "array", + "description": "The phraselists provided by eros you want \"text\" to be checked against.", + "required": true, + "items": { + "type": "string" + } + }, + } +} +``` + +That is the up-to-date schema, as of version 0.3.0.1 . It is liable to +change. If the version you downloaded is greater than 0.3.0.1, make sure to +check the schema (it is distributed with the package) to make sure it is up to +date. The schema is located in `res/schemata/erosc-input.json`. + +`erosc` will take that input, and send back output in JSON, in accordance with +the schema found in `res/schemata/erosc-output.json`. + +```json +{ + "name": "erosc-output", + "type": "array", + "description": "The output of erosc.", + "items": { + "type": "object", + "description": "The phraselist name, along with the score for that phraselist.", + "properties": { + "eros-list": { + "type": "string", + "description": "The name of the phraselist corresponding to this object." + }, + "score": { + "type": "number", + "description": "The score corresponding to this phraselist." + } + } + } +} +``` + +## Example + +This is the example input from `res/erosc-dummy-inputs/input0.json`. + +```json +{ + "text": "Fuck you, you fucking fuck! Fucking bitch tits milf sex sluts!", + "eros-lists": [ + "gambling", + "pornography" + ] +} +``` + +Running `erosc < res/erosc-dummy-inputs/input0.json` yields + +```json +[ + { + "score": 0, + "eros-list": "gambling" + }, + { + "score": 11394, + "eros-list": "pornography" + } +] +``` + +## Library + +You are welcome to build your own client, and use that. To do so, simply import +`Text.Eros`. Hackage seems to be unable to build the API documentation for Eros, +but it won't hurt to check +[eros on Hackage](http://hackage.haskell.org/package/eros). + +If that doesn't work, I publish the documentation +[here](https://pharpend.github.io/eros-haddock). + # Contributing If you want to contribute, you'll need `ghc` and `cabal-install` @@ -25,3 +138,22 @@ cd eros cabal sandbox init cabal install --enable-tests + +# Planned features + +## `erosc` ⟶ `eros-server` + +As it stands, `erosc` is tedious and a bit difficult to use. I plan on rewriting +`erosc` to act as an HTTP[s] server, using Happstack, using acid-state as a RAM +cloud. This will be the fastest and easiest to maintain solution. + +I will still include an offline client, but it won't be the focus of +development. + +## More options + +I need to add more filtering options, such as phraselist-specific thresholds, +custom phraselists, and, well, just more stuff. + +If you have any ideas, please don't hesitate to email me at +. diff --git a/eros.cabal b/eros.cabal --- a/eros.cabal +++ b/eros.cabal @@ -1,5 +1,5 @@ name: eros -version: 0.3.0.0 +version: 0.3.0.1 synopsis: A text censorship library. description: A Haskell library for censoring text, using @@ -17,7 +17,11 @@ towards a stable version, though! I recommend looking at the API documentation for Text.Eros if you want an idea - of how to use the library. + of how to use the library. Hackage seems to be completely unable to build the + documentation for Eros. For that reason, I publish the documentation + . + + -- homepage: https://eros.valkyrian.com/ license: BSD3 license-file: LICENSE @@ -39,7 +43,7 @@ library exposed-modules: Text.Eros - other-modules: + other-modules: Paths_eros , Text.Eros.Message , Text.Eros.Phrase diff --git a/src/library/Text/Eros.hs b/src/library/Text/Eros.hs deleted file mode 100644 --- a/src/library/Text/Eros.hs +++ /dev/null @@ -1,18 +0,0 @@ --- | --- Module : Text.Eros --- Description : Capstone Module for eros --- Copyright : 2014, Peter Harpending. --- License : BSD3 --- Maintainer : Peter Harpending --- Stability : experimental --- Portability : archlinux --- --- This module serves as a bit of a capstone to the whole eros --- library. The idea being you can just import this module, and get --- all the functionality from all the rest of eros. - -module Text.Eros (module Text.Eros) where - -import Text.Eros.Message as Text.Eros -import Text.Eros.Phrase as Text.Eros -import Text.Eros.Phraselist as Text.Eros diff --git a/src/library/Text/Eros.lhs b/src/library/Text/Eros.lhs new file mode 100644 --- /dev/null +++ b/src/library/Text/Eros.lhs @@ -0,0 +1,22 @@ +| +Module : Text.Eros +Description : Capstone Module for eros +Copyright : 2014, Peter Harpending. +License : BSD3 +Maintainer : Peter Harpending +Stability : experimental +Portability : archlinux + +This module serves as a bit of a capstone to the whole eros +library. The idea being you can just import this module, and get +all of the functions from all the rest of eros. + +You will have to look in the documentation for the sub-modules for +the functions. I haven't quite figured out how to get the +documentation to show up here yet. + +> module Text.Eros (module Text.Eros) where + +> import Text.Eros.Message as Text.Eros +> import Text.Eros.Phrase as Text.Eros +> import Text.Eros.Phraselist as Text.Eros