Update readme #304 (#306)

* update readme * add hackage badge * update cabal tested-with --------- Co-authored-by: Marco Zocca <[email protected]>
scotty-web · Sep 25, 2023 · dc66aa0 · dc66aa0
1 parent 36fda87
commit dc66aa0
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 19 deletions.
diff --git 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 ["<h1>Scotty, ", beam, " me up!</h1>"]
 ```
 
@@ -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
+
+<a href="https://github.com/scotty-web/scotty/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=scotty-web/scotty" />
+</a>
+
+
+# Copyright 
+(c) 2012-Present Andrew Farmer and Scotty contributors
diff --git 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
@@ -6,7 +6,7 @@ Bug-reports:         https://github.com/scotty-web/scotty/issues
 License:             BSD3
 License-file:        LICENSE
 Author:              Andrew Farmer <[email protected]>
-Maintainer:          Andrew Farmer <[email protected]>
+Maintainer:          Andrew Farmer <[email protected]> and the Scotty maintainers
 Copyright:           (c) 2012-Present Andrew Farmer
 Category:            Web
 Stability:           experimental
@@ -24,7 +24,7 @@ Description:
     .
     main = scotty 3000 $
     &#32;&#32;get &#34;/:word&#34; $ do
-    &#32;&#32;&#32;&#32;beam <- param &#34;word&#34;
+    &#32;&#32;&#32;&#32;beam <- captureParam &#34;word&#34;
     &#32;&#32;&#32;&#32;html $ mconcat [&#34;&#60;h1&#62;Scotty, &#34;, beam, &#34; me up!&#60;/h1&#62;&#34;]
   @
   .
@@ -44,16 +44,11 @@ Description:
   [WAI] <http://hackage.haskell.org/package/wai>
   .
   [Warp] <http://hackage.haskell.org/package/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