diff --git a/yesod-form/README.md b/yesod-form/README.md index b3d9c8d8..097995c4 100644 --- a/yesod-form/README.md +++ b/yesod-form/README.md @@ -2,3 +2,14 @@ Form handling for Yesod, in the same style as formlets. See [the forms chapter](http://www.yesodweb.com/book/forms) of the Yesod book. + +This package provies a set of basic form inputs such as text, number, time, +checkbox, select, textarea, and etc. via `Yesod.Form.Fields` module. Also, +there is `Yesod.Form.Nic` module providing richtext field using Nic editor. +However, this module is grandfathered now and Nic editor is not actively +maintained since June 2012. You can find additional richtext editor fields in +[`yesod-form-richtext`][yesod-form-richtext] package (currently in provides +support of [Summernote][summernote] editor only). + +[yesod-form-richtext]:http://hackage.haskell.org/package/yesod-form-richtext +[summernote]:http://summernote.org/ diff --git a/yesod-form/Yesod/Form/Nic.hs b/yesod-form/Yesod/Form/Nic.hs index 28626789..c291520c 100644 --- a/yesod-form/Yesod/Form/Nic.hs +++ b/yesod-form/Yesod/Form/Nic.hs @@ -4,6 +4,13 @@ {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE CPP #-} -- | Provide the user with a rich text editor. +-- +-- According to NIC editor homepage it is not actively maintained since June +-- 2012. There is another better alternative — open sourced Summernote editor +-- released under MIT licence. You can use Summernote in your Yesod forms via +-- separately distributed +-- +-- package. module Yesod.Form.Nic ( YesodNic (..) , nicHtmlField diff --git a/yesod-form/yesod-form.cabal b/yesod-form/yesod-form.cabal index a7f715d5..b4fe88c2 100644 --- a/yesod-form/yesod-form.cabal +++ b/yesod-form/yesod-form.cabal @@ -10,7 +10,7 @@ stability: Stable cabal-version: >= 1.8 build-type: Simple homepage: http://www.yesodweb.com/ -description: API docs and the README are available at +description: API docs and the README are available at . Third-party packages which you can find useful: - richtext form fields (currntly it provides only Summernote support). extra-source-files: ChangeLog.md README.md