homepage: https://github.com/swamp-agr/servant-seo#readme
changelog-type: markdown
hash: 2b7262f4fd8f2fd0978c4c9be7c19803afd4e5e261c5b67dc01b7ae1a64208e7
test-bench-deps:
  base: -any
  filepath: -any
  doctest: '>=0.11.1 && <0.18'
  servant-seo: -any
  QuickCheck: -any
  directory: '>=1.0'
maintainer: persiantiger@yandex.ru
synopsis: Generate Robots.txt and Sitemap.xml specification for your servant API.
changelog: |
  # Changelog for servant-sitemap

  ## 0.1.0 -- 2020-07-11

  - /robots.txt deriving from API: Disallow, Sitemap, User-agent commands.
  - /sitemap.xml deriving from API: Frequency, Priority optional tags included.
  - sitemap index support.
basic-deps:
  warp: -any
  bytestring: -any
  xml-conduit: -any
  base: '>=4.7 && <5'
  blaze-markup: -any
  text: -any
  servant-server: -any
  servant: -any
  containers: -any
  servant-blaze: -any
  lens: '>=4.18.1'
  binary: -any
  aeson: -any
  http-media: -any
all-versions:
- 0.1.0
author: Andrey Prokopenko
latest: 0.1.0
description-type: markdown
description: "# servant-seo\n\n## Installation\n\n- Add `servant-seo` to project dependencies.\n\n##
  Usage\n\n1. Restrict API with `Disallow` combinator to prevent robots making requests.\n\n
  \ ```haskell\n  type ProtectedAPI = Disallow \"admin\" :> Get '[HTML] AdminPage\n\n
  \ type StaticAPI = \"cdn\" :> Disallow \"static\" :> Raw\n  ```\n\n2. Add `Priority`
  and `Frequency` (optional step).\n\n  ```haskell\n  typw BlogAPI = \"blog\" :> Frequency
  'Always :> Get '[HTML] BlogPage\n  ```\n  \n3. Extend your API with something like:
  \n\n  ```haskell\n  Warp.runSettings Warp.defaultSettings $ serveWithSeo website
  api server\n  where\n    website = \"https://example.com\"\n  ```\n\nYou will have
  `/robots.txt` and `/sitemap.xml` automatically generated and ready to be served
  with your API.\n\nSee `Servant.Seo` module for detailed description and `example/Example.hs`
  for show case.\n\n## Acknowledgements\n\nThis library would not have happened without
  these people. Thank you!\n\n  - @fizruk and **Servant Contributors**: as source
  of inspiration.\n  - @isovector: for `Thinking with types` book.\n  \n"
license-name: BSD-3-Clause

Update from Hackage at 2020-07-11T20:46:30Z
Update from Hackage at 2020-07-11T20:46:30Z
