diff --git a/CHANGELOG.markdown b/CHANGELOG.markdown deleted file mode 100644 --- a/CHANGELOG.markdown +++ /dev/null @@ -1,4 +0,0 @@ -# Change log - -Burrito follows the [Package Versioning Policy](https://pvp.haskell.org). -You can find release notes [on GitHub](https://github.com/tfausak/burrito/releases). diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# Change log + +Burrito follows the [Package Versioning Policy](https://pvp.haskell.org). +You can find release notes [on GitHub](https://github.com/tfausak/burrito/releases). diff --git a/LICENSE.markdown b/LICENSE.markdown deleted file mode 100644 --- a/LICENSE.markdown +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2024 Taylor Fausak - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Taylor Fausak + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.markdown b/README.markdown deleted file mode 100644 --- a/README.markdown +++ /dev/null @@ -1,21 +0,0 @@ -# Burrito - -[![Workflow](https://github.com/tfausak/burrito/actions/workflows/workflow.yaml/badge.svg)](https://github.com/tfausak/burrito/actions/workflows/workflow.yaml) -[![Hackage](https://img.shields.io/hackage/v/burrito)](https://hackage.haskell.org/package/burrito) -[![Stackage](https://www.stackage.org/package/burrito/badge/nightly?label=stackage)](https://www.stackage.org/package/burrito) - -Burrito is a Haskell library for parsing and rendering URI templates. - -According to [RFC 6570](https://tools.ietf.org/html/rfc6570): "A URI Template -is a compact sequence of characters for describing a range of Uniform Resource -Identifiers through variable expansion." Burrito implements URI templates -according to the specification in that RFC. - -The term "uniform resource identifiers" (URI) is often used interchangeably -with other related terms like "internationalized resource identifier" (IRI), -"uniform resource locator" (URL), and "uniform resource name" (URN). Burrito -can be used for all of these. If you want to get technical, its input must be a -valid IRI and its output will be a valid URI or URN. - -Although Burrito is primarily intended to be used with HTTP and HTTPS URIs, it -should work with other schemes as well. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Burrito + +[![CI](https://github.com/tfausak/burrito/actions/workflows/ci.yml/badge.svg)](https://github.com/tfausak/burrito/actions/workflows/ci.yml) +[![Hackage](https://badgen.net/hackage/v/burrito)](https://hackage.haskell.org/package/burrito) + +Burrito is a Haskell library for parsing and rendering URI templates. + +According to [RFC 6570](https://tools.ietf.org/html/rfc6570): "A URI Template +is a compact sequence of characters for describing a range of Uniform Resource +Identifiers through variable expansion." Burrito implements URI templates +according to the specification in that RFC. + +The term "uniform resource identifiers" (URI) is often used interchangeably +with other related terms like "internationalized resource identifier" (IRI), +"uniform resource locator" (URL), and "uniform resource name" (URN). Burrito +can be used for all of these. If you want to get technical, its input must be a +valid IRI and its output will be a valid URI or URN. + +Although Burrito is primarily intended to be used with HTTP and HTTPS URIs, it +should work with other schemes as well. diff --git a/burrito.cabal b/burrito.cabal --- a/burrito.cabal +++ b/burrito.cabal @@ -1,6 +1,6 @@ cabal-version: 2.2 name: burrito -version: 2.0.1.9 +version: 2.0.1.10 synopsis: Parse and render URI templates. description: Burrito is a Haskell library for parsing and rendering URI templates. @@ -21,11 +21,11 @@ build-type: Simple category: Network -extra-source-files: - CHANGELOG.markdown - README.markdown +extra-doc-files: + CHANGELOG.md + README.md -license-file: LICENSE.markdown +license-file: LICENSE.txt license: MIT maintainer: Taylor Fausak @@ -39,15 +39,7 @@ manual: True common library - build-depends: - base >=4.16.0 && <4.20, - bytestring >=0.11.3 && <0.13, - containers >=0.6.5 && <0.7, - parsec >=3.1.15 && <3.2, - template-haskell >=2.18.0 && <2.22, - text >=1.2.5 && <1.3 || >=2.0 && <2.2, - transformers >=0.5.6 && <0.7, - + build-depends: base ^>=4.18.0.0 || ^>=4.19.0.0 || ^>=4.20.0.0 default-language: Haskell2010 ghc-options: -Weverything @@ -74,10 +66,17 @@ ghc-options: -rtsopts -threaded - -Wno-unused-packages library import: library + build-depends: + bytestring ^>=0.11.4.0 || ^>=0.12.0.2, + containers ^>=0.6.7 || ^>=0.7, + parsec ^>=3.1.16.1, + template-haskell ^>=2.20.0.0 || ^>=2.21.0.0 || ^>=2.22.0.0, + text ^>=2.0.2 || ^>=2.1, + transformers ^>=0.6.1.0, + exposed-modules: Burrito Burrito.Internal.Expand @@ -106,8 +105,10 @@ test-suite burrito-test-suite import: executable build-depends: - QuickCheck >=2.13.2 && <2.16, - hspec >=2.9.7 && <2.12, + QuickCheck ^>=2.14.3 || ^>=2.15, + containers, + hspec ^>=2.11.8, + text, hs-source-dirs: source/test-suite main-is: Main.hs