Prepare for releasing

CHANGES.md

@@ -0,0 +1,4 @@
+0.1.0 2021-02-03
+--------------
+
+- Initial public release

README.md

@@ -5,9 +5,9 @@ in OCaml.
 
 ## Installation
 
-Piaf is currently unreleased.
+Piaf is released to OPAM.
 
-You can depend on it via [esy](esy) resolutions or `opam pin`
+You can depend on it via [esy](esy) or by running `opam install piaf`.
 
 _Note_: make sure to mirror Piaf's own resolutions located in the [opam
 file](./piaf.opam).
@@ -25,12 +25,12 @@ open Piaf
 
 let get_sync url =
   let open Lwt_result.Syntax in
-  
+
   Lwt_main.run begin
     print_endline("Sending request...");
-    
+
     let* response = Client.Oneshot.get (Uri.of_string url) in
-    
+
     if (Status.is_successful response.status) then
       Body.to_string response.body
     else

nix/sources.nix

@@ -1,21 +1,20 @@
 { ocamlVersion ? "4_11" }:
-
 let
   overlays =
-    builtins.fetchTarball
-      https://github.com/anmonteiro/nix-overlays/archive/1871871.tar.gz;
+    /Users/anmonteiro/projects/nix-overlays;
+  # builtins.fetchTarball
+  # https://github.com/anmonteiro/nix-overlays/archive/1871871.tar.gz;
 
 in
+import "${overlays}/sources.nix" {
+  overlays = [
+    (import overlays)
+    (self: super: {
+      ocamlPackages = super.ocaml-ng."ocamlPackages_${ocamlVersion}";
 
-  import "${overlays}/sources.nix" {
-    overlays = [
-      (import overlays)
-      (self: super: {
-        ocamlPackages = super.ocaml-ng."ocamlPackages_${ocamlVersion}";
-
-        pkgsCross.musl64 = super.pkgsCross.musl64 // {
-          ocamlPackages = super.pkgsCross.musl64.ocaml-ng."ocamlPackages_${ocamlVersion}";
-        };
-      })
-    ];
-  }
+      pkgsCross.musl64 = super.pkgsCross.musl64 // {
+        ocamlPackages = super.pkgsCross.musl64.ocaml-ng."ocamlPackages_${ocamlVersion}";
+      };
+    })
+  ];
+}

piaf.opam

@@ -31,3 +31,5 @@ depends: [
 ]
 synopsis:
   "An HTTP library with HTTP/2 support written entirely in OCaml"
+description:
+  "Piaf is an HTTP library and webserver written entirely in OCaml."

shell.nix

@@ -1,5 +1,6 @@
+{ release-mode ? false }:
 let
-  pkgs = import ./nix/sources.nix {};
+  pkgs = import ./nix/sources.nix { };
   inherit (pkgs) lib;
   piafPkgs = pkgs.recurseIntoAttrs (import ./nix { inherit pkgs; }).native;
   piafDrvs = lib.filterAttrs (_: value: lib.isDerivation value) piafPkgs;
@@ -15,12 +16,20 @@ let
       inputs;
 
 in
-  with pkgs;
+with pkgs;
 
-  (mkShell {
-    inputsFrom = lib.attrValues piafDrvs;
-    buildInputs = with ocamlPackages; [ merlin ocamlformat utop ];
-  }).overrideAttrs (o : {
-    propagatedBuildInputs = filterDrvs o.propagatedBuildInputs;
-    buildInputs = filterDrvs o.buildInputs;
-  })
+(mkShell {
+  inputsFrom = lib.attrValues piafDrvs;
+  buildInputs =
+    (if release-mode then [
+      cacert
+      curl
+      ocamlPackages.dune-release
+      git
+      opam
+    ] else [ ]) ++
+    (with ocamlPackages; [ merlin ocamlformat utop ]);
+}).overrideAttrs (o: {
+  propagatedBuildInputs = filterDrvs o.propagatedBuildInputs;
+  buildInputs = filterDrvs o.buildInputs;
+})