summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcdepillabout <>2019-09-10 17:17:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2019-09-10 17:17:00 (GMT)
commit8697840fa3adece3d848b22e689f1ac800a7325e (patch)
tree636ac3c40f9194a6225ad4fda8bf7807d3bd0d7a
parent33dc47fb5481cc07de5e95d1a592adb2837d7d29 (diff)
version 0.2.2.1HEAD0.2.2.1master
-rw-r--r--CHANGELOG.md5
-rw-r--r--servant-static-th.cabal2
-rw-r--r--src/Servant/Static/TH.hs8
3 files changed, 14 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 70efb5c..cc26c99 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,10 @@
# Changelog
+## v0.2.2.1
+
+- Update haddocks with a note to use `extra-source-files` in your `.cabal`
+ file. Thanks [fkellner](https://github.com/fkellner)! [#8](https://github.com/cdepillabout/servant-static-th/pull/8)
+
## v0.2.2.0
- This adds MIME types for json, xml, gex. Thanks [delanoe](https://github.com/delanoe)! [#5](https://github.com/cdepillabout/servant-static-th/pull/5)
diff --git a/servant-static-th.cabal b/servant-static-th.cabal
index 0805274..18e9051 100644
--- a/servant-static-th.cabal
+++ b/servant-static-th.cabal
@@ -1,5 +1,5 @@
name: servant-static-th
-version: 0.2.2.0
+version: 0.2.2.1
synopsis: Embed a directory of static files in your Servant server
description: Please see <https://github.com/cdepillabout/servant-static-th#readme README.md>.
homepage: https://github.com/cdepillabout/servant-static-th
diff --git a/src/Servant/Static/TH.hs b/src/Servant/Static/TH.hs
index 978eb5a..5ecec05 100644
--- a/src/Servant/Static/TH.hs
+++ b/src/Servant/Static/TH.hs
@@ -87,6 +87,14 @@ prototypes and internal applications.
This shouldn't be used for high-traffic websites. Instead, you should serve
your static files from something like Apache, nginx, or a CDN.
+
+Note:
+
+If you are creating a @cabal@ package that needs to work with @cabal-install@,
+the @\"dir\"@ you want to serve needs to be a relative path inside your
+project root, and all contained files need to be listed in your
+@.cabal@-file under the @extra-source-files@ field so that they are
+included and available at compile-time.
-}
module Servant.Static.TH