Revamp README and remove website (#238)

jaspervdj · Dec 22, 2023 · e0ac03d · e0ac03d
1 parent da1fd1d
commit e0ac03d
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 240 deletions.
diff --git a/README.md b/README.md
@@ -1,34 +1,37 @@
-websockets
-==========
+# websockets
 
-Introduction
-------------
+![Hackage Version](https://img.shields.io/hackage/v/websockets)
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/jaspervdj/websockets/ci.yml)
 
-Provides a sensible, clean and simple way to write WebSocket-capable servers in
-Haskell.
+Provides a sensible, clean and simple way to write WebSocket
+server and client in Haskell.
 
-The following program echoes messages back after appending `meow`:
+## Features
 
-```haskell
-{-# LANGUAGE OverloadedStrings #-}
-import           Control.Monad      (forever)
-import qualified Data.Text          as T
-import qualified Network.WebSockets as WS
+- Provides Server/Client implementations of the websocket protocol
+- Ping/Pong building blocks for stale connection checking
+- TLS support via [wuss](https://hackage.haskell.org/package/wuss) package
 
-meow :: WS.Connection -> IO ()
-meow conn = forever $ do
-    msg <- WS.receiveData conn
-    WS.sendTextData conn $ msg `T.append` ", meow"
-```
+## Caveats
+
+- [Doesn't implement client ping/pong](https://github.com/jaspervdj/websockets/issues/159)
+- [Send doesn't support streaming](https://github.com/jaspervdj/websockets/issues/119)
+- [Requires careful handling of exceptions](https://github.com/jaspervdj/websockets/issues/48)
+- [DeflateCompression isn't thread-safe](https://github.com/jaspervdj/websockets/issues/208)
+
+## Introduction
+
+See [server](./example/server.lhs) and [client](./example/client.hs) implementations.
+
+## Installation
 
-Installation is provided using cabal:
+Using cabal:
 
 ```
 $ cabal install websockets
 ```
 
-Authors
--------
+## Authors
 
 An initial WebSockets library was written in 2010 by Siniša Biđin. In 2011, it
 was rewritten from scratch, and extended to its current state by Jasper Van der
@@ -43,9 +46,9 @@ Contributors:
 - Nathan Howell
 - Steffen Schuldenzucker
 - Yi Huang
+- Domen Kožar
 
-Development
------------
+## Development
 
 Pull requests are always welcome!
 

diff --git a/stack.yaml b/stack.yaml
@@ -3,7 +3,6 @@ save-hackage-creds: false
 flags:
   websockets:
     example: true
-    website: true
 extra-deps:
 - 'hakyll-4.15.1.0'
 nix:

diff --git a/web/.gitignore b/web/.gitignore
diff --git a/web/css/default.css b/web/css/default.css
diff --git a/web/css/syntax.css b/web/css/syntax.css
diff --git a/web/site.hs b/web/site.hs
diff --git a/web/templates/default.html b/web/templates/default.html
diff --git a/websockets.cabal b/websockets.cabal
@@ -52,11 +52,6 @@ Flag Example
   Default:     False
   Manual:      True
 
-Flag Website
-  Description: Build the website
-  Default:     False
-  Manual:      True
-
 Library
   Hs-source-dirs: src
   Ghc-options:      -Wall
@@ -243,15 +238,3 @@ Benchmark bench-mask
     SHA               >= 1.5    && < 1.7,
     text              >= 0.10   && < 2.2,
     entropy           >= 0.2.1  && < 0.5
-
-Executable websockets-website
-  If !flag(Website)
-    Buildable: False
-
-  Main-is:        site.hs
-  Hs-source-dirs: web
-  Default-language: Haskell2010
-  Build-depends:
-    base     >= 4    && < 5,
-    filepath >= 1.4  && < 1.5,
-    hakyll   >= 4.15 && < 4.16