Skip to content

Commit

Permalink
doc bump
Browse files Browse the repository at this point in the history
  • Loading branch information
bergmark committed Aug 18, 2012
1 parent 7d57748 commit 098ab7a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
19 changes: 9 additions & 10 deletions README.md
Expand Up @@ -19,25 +19,20 @@ Features
* Uses Fay's pretty print option (js-beautify) to create JS files that
are easier to debug.
* Writes JS to disk to allow reading the generated source.
* Share Fay source files between Haskell and Fay.


Installation
------------

You will need Haskell, Snap and Fay installed. The simplest way to get
up and running with Haskell is to install
You will need Haskell. The simplest way to get up and running with is
to install
[The Haskell Platform](http://hackage.haskell.org/platform/).

Snap and Fay are available on hackage:

```
cabal install snap fay
Everything else is available on hackage:
```

Clone this repository and install the package:
cabal install snaplet-fay
```
cabal install
````


Example Usage
Expand All @@ -47,6 +42,8 @@ Site.hs:
```
import Snap.Snaplet.Fay
routes = [..., ("/fay", with fay fayServe)]
app :: SnapletInit App App
app = makeSnaplet "app" "A snaplet example application." Nothing $ do
fay' <- nestSnaplet "fay" fay initFay
Expand All @@ -73,6 +70,8 @@ devel.cfg will not be created if you have already created the fay
directory, if this happens to you move snaplets/fay, start your
application, and then move the files back into snaplets/fay.

Any requests to the specified directory (in this case /fay/) will
compile the appropriate Fay file and serve it.

Development Status
------------------
Expand Down
3 changes: 2 additions & 1 deletion snaplet-fay.cabal
Expand Up @@ -8,12 +8,13 @@ name: snaplet-fay
version: 0.1.0.0
synopsis: Fay integration for Snap with automatic (re)compilation during development
description: Fay integration for Snap with automatic (re)compilation during development.
For more information, please see <https://github.com/faylang/snaplet-fay> .
For more information, please see <https://github.com/faylang/snaplet-fay>.
license: BSD3
license-file: LICENSE
author: Adam Bergmark
maintainer: adam@edea.se
homepage: https://github.com/faylang/snaplet-fay
bug-reports: https://github.com/faylang/snaplet-fay/issues
category: Web, Snap
build-type: Simple
cabal-version: >=1.8
Expand Down

0 comments on commit 098ab7a

Please sign in to comment.