diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,22 +1,7 @@ # Change log Wuss uses [Semantic Versioning][]. - -## v1.0.2 (2015-06-04) - -- Added an example without certificate validation. - -## v1.0.1 (2015-06-04) - -- Improved documentation. -- Supported doctest 0.10. - -## v1.0.0 (2015-04-15) - -- Initially released. - -## v0.0.0 (2015-04-15) - -- Initially created. +The change log is available through the [releases on GitHub][]. -[semantic versioning]: http://semver.org/spec/v2.0.0.html +[Semantic Versioning]: http://semver.org/spec/v2.0.0.html +[releases on GitHub]: https://github.com/tfausak/wuss/releases diff --git a/LICENSE.md b/LICENSE.md --- a/LICENSE.md +++ b/LICENSE.md @@ -1,21 +1,23 @@ -The MIT License (MIT) +[The MIT License (MIT)][] -Copyright (c) 2015 Taylor Fausak +Copyright (c) 2016 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: +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 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. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[The MIT License (MIT)]: https://opensource.org/licenses/MIT diff --git a/README.md b/README.md deleted file mode 100644 --- a/README.md +++ /dev/null @@ -1,79 +0,0 @@ -# [Wuss][] - -Secure WebSocket (WSS) clients in Haskell. - -[![Version][]](https://hackage.haskell.org/package/wuss) -[![Build][]](https://travis-ci.org/tfausak/wuss) -[![Dependencies][]](http://packdeps.haskellers.com/feed?needle=wuss) - ---- - -Wuss is a library that lets you easily create secure WebSocket clients over the -WSS protocol. It is a small addition to [the `websockets` package][] and is -adapted from existing solutions by [@jaspervdj][], [@mpickering][], and -[@elfenlaid][]. - -- [Installation](#installation) -- [Usage](#usage) - -## Installation - -To add Wuss as a dependency to your package, add it to your Cabal file. - -``` -build-depends: wuss ==1.0.* -``` - -For other use cases, install it with Cabal. - -``` sh -$ cabal install 'wuss ==1.0.*' -``` - -Wuss uses [Semantic Versioning][]. See [the change log][] for a detailed list -of changes. - -## Usage - -``` hs -import Wuss - -import Control.Concurrent (forkIO) -import Control.Monad (forever, unless, void) -import Data.Text (Text, pack) -import Network.WebSockets (ClientApp, receiveData, sendClose, sendTextData) - -main :: IO () -main = runSecureClient "echo.websocket.org" 443 "/" ws - -ws :: ClientApp () -ws connection = do - putStrLn "Connected!" - - void . forkIO . forever $ do - message <- receiveData connection - print (message :: Text) - - let loop = do - line <- getLine - unless (null line) $ do - sendTextData connection (pack line) - loop - loop - - sendClose connection (pack "Bye!") -``` - -For more information about Wuss, please read [the Haddock documentation][]. - -[wuss]: http://taylor.fausak.me/wuss/ -[version]: https://img.shields.io/hackage/v/wuss.svg?label=version&style=flat-square -[build]: https://img.shields.io/travis/tfausak/wuss/master.svg?label=build&style=flat-square -[dependencies]: https://img.shields.io/hackage-deps/v/wuss.svg?label=dependencies&style=flat-square -[the `websockets` package]: https://hackage.haskell.org/package/websockets -[@jaspervdj]: https://gist.github.com/jaspervdj/7198388 -[@mpickering]: https://gist.github.com/mpickering/f1b7ba3190a4bb5884f3 -[@elfenlaid]: https://gist.github.com/elfenlaid/7b5c28065e67e4cf0767 -[semantic versioning]: http://semver.org/spec/v2.0.0.html -[the change log]: CHANGELOG.md -[the haddock documentation]: https://hackage.haskell.org/package/wuss diff --git a/Setup.hs b/Setup.hs --- a/Setup.hs +++ b/Setup.hs @@ -1,6 +1,4 @@ -module Main (main) where - -import Distribution.Simple (defaultMain) +import qualified Distribution.Simple main :: IO () -main = defaultMain +main = Distribution.Simple.defaultMain diff --git a/WussTest.hs b/WussTest.hs deleted file mode 100644 --- a/WussTest.hs +++ /dev/null @@ -1,6 +0,0 @@ -module Main (main) where - -import Test.DocTest (doctest) - -main :: IO () -main = doctest ["Wuss.hs"] diff --git a/package.yaml b/package.yaml new file mode 100644 --- /dev/null +++ b/package.yaml @@ -0,0 +1,28 @@ +category: Network +description: Wuss is a library that lets you easily create secure WebSocket + clients over the WSS protocol. It is a small addition to + and + is adapted from existing solutions by + , + , and + . +extra-source-files: +- CHANGELOG.md +- LICENSE.md +- package.yaml +- stack.yaml +ghc-options: -Wall +github: tfausak/wuss +library: + dependencies: + - base ==4.* + - bytestring + - connection ==0.2.* + - network + - websockets ==0.9.* + exposed-modules: Wuss +license: MIT +maintainer: Taylor Fausak +name: wuss +synopsis: Secure WebSocket (WSS) clients +version: '1.0.4' diff --git a/stack.yaml b/stack.yaml new file mode 100644 --- /dev/null +++ b/stack.yaml @@ -0,0 +1,3 @@ +install-ghc: true +require-stack-version: ! '>=1.0.4' +resolver: lts-5.12 diff --git a/wuss.cabal b/wuss.cabal --- a/wuss.cabal +++ b/wuss.cabal @@ -1,50 +1,39 @@ -name: wuss -version: 1.0.2 -cabal-version: >=1.10 -build-type: Simple -license: MIT -license-file: LICENSE.md -copyright: 2015 Taylor Fausak -maintainer: Taylor Fausak -homepage: http://taylor.fausak.me/wuss/ -bug-reports: https://github.com/tfausak/wuss/issues -synopsis: Secure WebSocket (WSS) clients -description: - Wuss is a library that lets you easily create secure WebSocket clients over - the WSS protocol. It is a small addition to - - and is adapted from existing solutions by - , - , and - . -category: Network -author: Taylor Fausak +-- This file has been generated from package.yaml by hpack version 0.9.0. +-- +-- see: https://github.com/sol/hpack + +name: wuss +version: 1.0.4 +synopsis: Secure WebSocket (WSS) clients +description: Wuss is a library that lets you easily create secure WebSocket clients over the WSS protocol. It is a small addition to and is adapted from existing solutions by , , and . +category: Network +homepage: https://github.com/tfausak/wuss#readme +bug-reports: https://github.com/tfausak/wuss/issues +maintainer: Taylor Fausak +license: MIT +build-type: Simple +cabal-version: >= 1.10 + extra-source-files: CHANGELOG.md - README.md + LICENSE.md + package.yaml + stack.yaml source-repository head - type: git - location: https://github.com/tfausak/wuss + type: git + location: https://github.com/tfausak/wuss library - exposed-modules: - Wuss - build-depends: - base ==4.*, - bytestring -any, - connection ==0.2.*, - network -any, - websockets ==0.9.* - default-language: Haskell2010 - ghc-options: -Wall - -test-suite test - type: exitcode-stdio-1.0 - main-is: WussTest.hs - build-depends: - base -any, - doctest >=0.9 && <0.11, - wuss -any - default-language: Haskell2010 - ghc-options: -Wall + ghc-options: -Wall + build-depends: + base ==4.* + , bytestring + , connection ==0.2.* + , network + , websockets ==0.9.* + exposed-modules: + Wuss + other-modules: + Paths_wuss + default-language: Haskell2010