servant-docs-simple 0.2.0.0 → 0.2.0.1

raw patch · 3 files changed

+15/−7 lines, 3 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• CHANGELOG.md +10/−4
• README.md +4/−2
• servant-docs-simple.cabal +1/−1

@@ -1,11 +1,17 @@ # Changelog -`servant-docs-simple` uses [PVP Versioning][1].-The changelog is available [on GitHub][2].+[The latest version of this document is on GitHub.](https://github.com/Holmusk/servant-docs-simple/blob/master/CHANGELOG.md)  ## 0.1.0.0  * Initially created. -[1]: https://pvp.haskell.org-[2]: https://github.com/Holmusk/servant-docs-simple/releases+## 0.2.0.0++* Use OMap as underlying representation for intermediate documentation structure. ++* Expose HasDocumentApi typeclass to allow custom API type combinator parsing.++## 0.2.0.1++* Update CHANGELOG, README

@@ -26,6 +26,8 @@  [**In-depth explanation here**](https://github.com/Holmusk/servant-docs-simple#faq) +[**Tutorials**](https://github.com/Holmusk/servant-docs-simple#tutorials)+ # Example usage  **Using this script**@@ -166,9 +168,9 @@    This is so we can index our library with these types to get the relevant    fields, examples for these. -**Why don't we use Servant.Docs?**+**How does our usecase differ from Servant.Docs?** -1) `Servant.Docs` generates documentation **only if** `Format Types` have+1) `Servant.Docs` generates documentation only if `Format Types` have   implemented the necessary instances.      ``` haskell

@@ -1,6 +1,6 @@ cabal-version:       2.4 name:                servant-docs-simple-version:             0.2.0.0+version:             0.2.0.1 synopsis:            Generate endpoints overview for Servant API  description: