Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
coffee-cup committed Aug 30, 2024
1 parent 4361195 commit 20a3237
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# nix-npm-overlay

Overlay to fix Nix versions of NPM, PNPM, and Yarn.
This repository is a Nix overlay for NPM, PNPM, and Yarn. It is used in [Nixpacks](https://github.com/railwayapp/nixpacks).

This is used in [Nixpacks](https://github.com/railwayapp/nixpacks).
Nix derivations for these package managers are automatically generated for the latest versions.

## Usage

```nix
{ pkgs ? import <nixpkgs> {} }:
let
npmOverlay = import (builtins.fetchTarball "https://github.com/railwayapp/nix-npm-overlay/archive/main.tar.gz");
pkgs = import (fetchTarball "https://github.com/NixOS/nixpkgs/archive/nixos-unstable.tar.gz") {
overlays = [ npmOverlay ];
};
in
pkgs.buildEnv {
name = "npm-overlay-env";
paths = with pkgs; [
nodejs_20
pnpm-9_x
];
}
```

0 comments on commit 20a3237

Please sign in to comment.