Add top-level documentation and CI action to upload it

Author: s-and-witch

.github/workflows/push-to-master.yml

@@ -0,0 +1,46 @@
+name: "Handle push to master"
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        ghc: [ghc984, ghc9102, ghc9122]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch repo
+        uses: actions/checkout@v4
+
+      - name: Install nix
+        uses: cachix/install-nix-action@v26
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+
+      # Build and run
+      - name: Build tests runner
+        run: nix build .#packages.x86_64-linux.${{ matrix.ghc }}.webcolor-labels
+
+  handle-push-to-master:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch repo
+        uses: actions/checkout@v4
+
+      - name: Install nix
+        uses: cachix/install-nix-action@v26
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+
+      - name: Build webcolor-labels-dist
+        run: nix build .#webcolor-labels-dist
+
+      - name: Deploy webcolor-labels release candidate
+        uses: haskell-actions/hackage-publish@v1
+        with:
+          hackageToken: ${{ secrets.HACKAGE_API_KEY }}
+          packagesPath: result/packages
+          docsPath: result/docs
+          publish: false

README.md

@@ -2,6 +2,8 @@
 
 Zero-dependency, plug-and-play library that enables #hex-color syntax for your own types!
 
+![Demo image](images/demo.png)
+
 ## Motivation
 
 [Unrestricted OverloadedLabels syntax](https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0170-unrestricted-overloadedlabels.rst) was implemented in GHC 9.6.1. It isn't hard to notice

flake.nix

@@ -13,18 +13,39 @@
   outputs = { self, nixpkgs, flake-utils }:
     flake-utils.lib.eachDefaultSystem (system:
       let
-        pkgs = nixpkgs.legacyPackages.${system};
+        pkgs = import nixpkgs {
+          inherit system;
+          overlays = [overlay];
+        };
+
+        overlay = _: prev: {
+          haskell = prev.haskell // {
+            packages = pkgs.lib.mapAttrs overrideHaskellPackages prev.haskell.packages;
+          };
+        };
+
+        overrideHaskellPackages = _: hp: hp.override {
+          overrides = _: _: {
+            "${packageName}" = hp.callCabal2nix packageName self {};
+          };
+        };
 
         haskellPackages = pkgs.haskellPackages;
 
         packageName = "webcolor-labels";
+
+        mkPackage = _: hp: { "${packageName}" = hp."${packageName}";};
       in {
-        packages.${packageName} =
-          haskellPackages.callCabal2nix packageName self {
-            # Dependency overrides go here
-          };
 
-        packages."${packageName}-dist" =
+
+
+        packages = pkgs.lib.mapAttrs mkPackage pkgs.haskell.packages // {
+
+          "${packageName}" = haskellPackages."${packageName}";
+
+          default = self.packages.${system}."${packageName}";
+
+          "${packageName}-dist" =
           with pkgs.haskell.lib;
           let distPackage = self.packages.${system}.default;
           in pkgs.runCommand "pack-${packageName}-dist" {} ''
@@ -33,8 +54,8 @@
             cp -r ${sdistTarball distPackage}/${distPackage.name}.tar.gz $out/packages
             cp -r ${documentationTarball distPackage}/${distPackage.name}-docs.tar.gz $out/docs
           '';
+        };
 
-        packages.default = self.packages.${system}.${packageName};
         defaultPackage = self.packages.${system}.default;
 
         devShells.default = pkgs.mkShell {
@@ -44,7 +65,7 @@
             cabal-install
             haskellPackages.cabal-fmt
           ];
-          inputsFrom = map (__getAttr "env") (__attrValues self.packages.${system});
+          inputsFrom = [ self.defaultPackage.${system}.env ];
         };
         devShell = self.devShells.${system}.default;
       });