Merge pull request 'Update readme' (#67) from cobaltcause/flake-compat:readme into main

Reviewed-on: lix-project/flake-compat#67

README.md

@@ -2,25 +2,14 @@
 
 ## Usage
 
-> [!WARNING]
-> During the Lix private beta period during which Forgejo is private, this
-> requires configuring netrc in Lix for the tarball download to work.
->
-> Your netrc should look something like so:
-> ```
-> machine git.lix.systems login YOUR-USERNAME password SOME-PERSONAL-ACCESS-TOKEN-REPO-READ
-> ```
->
-> We are terribly sorry for the UX for this being very bad
-> ([issue](https://git.lix.systems/lix-project/lix/issues/254)).
-
 To use, add the following to your `flake.nix`:
 
-<!-- FIXME: this can use the standard non-api archive url when we are
-un-privated -->
-
 ```nix
-inputs.flake-compat.url = "https://git.lix.systems/api/v1/repos/lix-project/flake-compat/archive/main.tar.gz";
+inputs.flake-compat = {
+  url = "git+https://git.lix.systems/lix-project/flake-compat";
+  # Optional:
+  flake = false;
+};
 ```
 
 Afterwards, create a `default.nix` file containing the following:
@@ -28,10 +17,13 @@ Afterwards, create a `default.nix` file containing the following:
 ```nix
 (import
   (
-    let lock = builtins.fromJSON (builtins.readFile ./flake.lock); in
+    let
-    fetchTarball {
+      lock = builtins.fromJSON (builtins.readFile ./flake.lock);
-      url = lock.nodes.flake-compat.locked.url;
+      inherit (lock.nodes.flake-compat.locked) narHash rev url;
-      sha256 = lock.nodes.flake-compat.locked.narHash;
+    in
+    builtins.fetchTarball {
+      url = "${url}/archive/${rev}.tar.gz";
+      sha256 = narHash;
     }
   )
   { src = ./.; }

default.nix

@@ -228,6 +228,8 @@ let
 
 in
   rec {
+    inputs = result.inputs // { self = result; };
+
     defaultNix =
       (builtins.removeAttrs result ["__functor"])
       // (if result ? defaultPackage.${system} then { default = result.defaultPackage.${system}; } else {})