add CI and readme

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
         run: |
           wget https://github.com/Kleidukos/get-tested/releases/download/v0.1.5.0/get-tested-0.1.5.0-linux-amd64 -O get-tested
           chmod +x get-tested
-          ./get-tested --ubuntu --macos $PROJECT_NAME.cabal >> $GITHUB_OUTPUT
+          ./get-tested --ubuntu $PROJECT_NAME.cabal >> $GITHUB_OUTPUT
   tests:
     name: ${{ matrix.ghc }} on ${{ matrix.os }}
     needs: generate-matrix
@@ -35,7 +35,7 @@ jobs:
         uses: actions/checkout@v4
       - name: Set up Haskell
         id: setup-haskell
-        uses: haskell/actions/setup@v2
+        uses: haskell-actions/setup
         with:
           ghc-version: ${{ matrix.ghc }}
           cabal-version: 'latest'

README.md

@@ -1,3 +1,27 @@
 # blaze-html-qq
 
+[![CI](https://github.com/ocramz/blaze-html-qq/actions/workflows/ci.yml/badge.svg)](https://github.com/ocramz/blaze-html-qq/actions/workflows/ci.yml)
 
+QuasiQuoter for `blaze-html`. Parse inline HTML snippets at compile time and produce `MarkdownM` values, e.g. 
+
+```haskell
+{-# language QuasiQuotes #-}
+import qualified Data.Text.Lazy as TL (Text)
+import qualified Text.Blaze.Html.Renderer.Text as BT (renderHtml)
+
+import Text.Blaze.HTML.QQ (blaze)
+
+test :: TL.Text
+test = BT.renderHtml [blaze|
+<div>
+  <h1 class="widget" style="potato">
+  Hello!
+  </h1>
+</div>
+|]
+```
+
+```
+> test
+"<div><h1 class=\"widget\" style=\"potato\">Hello!</h1></div>"
+```