From dc66aa082808b7a9884d748e1a86a8e491c67e32 Mon Sep 17 00:00:00 2001 From: Marco Z Date: Mon, 25 Sep 2023 22:15:07 +0200 Subject: [PATCH] Update readme #304 (#306) * update readme * add hackage badge * update cabal tested-with --------- Co-authored-by: Marco Zocca --- README.md | 29 ++++++++++++++++++++++------- changelog.md | 1 + scotty.cabal | 19 +++++++------------ 3 files changed, 30 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index ae35ac22..46f3fb51 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Scotty [![Build Status](https://travis-ci.org/scotty-web/scotty.svg)](https://travis-ci.org/scotty-web/scotty) +# Scotty [![Hackage](http://img.shields.io/hackage/v/scotty.svg)](https://hackage.haskell.org/package/scotty) [![CI](https://github.com/scotty-web/scotty/actions/workflows/haskell-ci.yml/badge.svg)](https://github.com/scotty-web/scotty/actions/workflows/haskell-ci.yml) A Haskell web framework inspired by Ruby's Sinatra, using WAI and Warp. @@ -10,7 +10,7 @@ import Data.Monoid (mconcat) main = scotty 3000 $ get "/:word" $ do - beam <- param "word" + beam <- captureParam "word" html $ mconcat ["

Scotty, ", beam, " me up!

"] ``` @@ -31,17 +31,22 @@ Setting phasers to stun... (port 3000) (ctrl-c to quit) As for the name: Sinatra + Warp = Scotty. -### More Information +## More Information Tutorials and related projects can be found in the [Scotty wiki](https://github.com/scotty-web/scotty/wiki). -### Development & Support +## Contributing -Open an issue on GitHub. +Feel free to ask questions or report bugs on the [Github issue tracker](https://github.com/scotty-web/scotty/issues/). -Copyright (c) 2012-2019 Andrew Farmer +Github issues are now (September 2023) labeled, so newcomers to the Haskell language can start with `easy fix` ones and gradually progress to `new feature`s, `bug`s and `R&D` :) -### FAQ +## Package version numbers + +Scotty adheres to the [Package Versioning Policy](https://pvp.haskell.org/). + + +## FAQ * Fails to compile regex-posix on Windows * If you are using stack, add the following parameters to `stack.yaml`: @@ -57,3 +62,13 @@ Copyright (c) 2012-2019 Andrew Farmer constraints: regex-posix +_regex-posix-clib ``` + +### Contributors + + + + + + +# Copyright +(c) 2012-Present Andrew Farmer and Scotty contributors diff --git a/changelog.md b/changelog.md index 2388db9b..c2cb900a 100644 --- a/changelog.md +++ b/changelog.md @@ -1,6 +1,7 @@ ## next [????.??.??] * Adds a new `nested` handler that allows you to place an entire WAI Application under a Scotty route * Disambiguate request parameters (#204). Adjust the `Env` type to have three [Param] fields instead of one, add `captureParam`, `formParam`, `queryParam` and the associated `captureParams`, `formParams`, `queryParams`. Add deprecation notices to `param` and `params`. +* Add `Scotty.Cookie` module. ## 0.12.1 [2022.11.17] * Fix CPP bug that prevented tests from building on Windows. diff --git a/scotty.cabal b/scotty.cabal index 96e90091..40e45b89 100644 --- a/scotty.cabal +++ b/scotty.cabal @@ -6,7 +6,7 @@ Bug-reports: https://github.com/scotty-web/scotty/issues License: BSD3 License-file: LICENSE Author: Andrew Farmer -Maintainer: Andrew Farmer +Maintainer: Andrew Farmer and the Scotty maintainers Copyright: (c) 2012-Present Andrew Farmer Category: Web Stability: experimental @@ -24,7 +24,7 @@ Description: . main = scotty 3000 $ get "/:word" $ do - beam <- param "word" + beam <- captureParam "word" html $ mconcat ["<h1>Scotty, ", beam, " me up!</h1>"] @ . @@ -44,16 +44,11 @@ Description: [WAI] . [Warp] -tested-with: GHC == 7.6.3 - , GHC == 7.8.4 - , GHC == 7.10.3 - , GHC == 8.0.2 - , GHC == 8.2.2 - , GHC == 8.4.4 - , GHC == 8.6.5 - , GHC == 8.8.4 - , GHC == 8.10.4 - , GHC == 9.0.1 +tested-with: GHC == 8.10.7 + , GHC == 9.0.2 + , GHC == 9.2.8 + , GHC == 9.4.6 + , GHC == 9.6.2 Extra-source-files: README.md changelog.md