Update README

nexryai · Jul 12, 2024 · 0c34e20 · 0c34e20
1 parent 6c262ad
commit 0c34e20
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,41 @@
 ## npmrun
-A low-memory replacement for "npm run" written in Rust for Docker containers.
+A low-memory replacement for "npm run" written in Rust for Docker containers.
+
+### Usage
+```Dockerfile
+FROM rust:1-alpine as npmrun-builder
+WORKDIR /src
+
+RUN apk add --no-cache git alpine-sdk
+
+RUN git clone https://github.com/nexryai/npmrun.git .
+RUN cargo build --release
+
+FROM node:20-alpine3.19 AS builder
+
+ARG NODE_ENV=production
+
+########
+# <Command to build your app>
+########
+
+FROM node:20-alpine3.19 AS runner
+
+########
+# <Copy files from builder>
+########
+
+COPY --from=npmrun-builder /src/target/release/npmrun /usr/local/bin/npmrun
+
+ENV NODE_ENV=production
+ENTRYPOINT ["/sbin/tini", "--"]
+CMD ["npmrun", "docker:start"]
+```
+
+### Effects
+
+#### Before
+![Before](https://raw.githubusercontent.com/nexryai/npmrun/main/docs/before.png)
+
+#### After
+![After](https://raw.githubusercontent.com/nexryai/npmrun/main/docs/after.png)
diff --git a/docs/after.png b/docs/after.png
diff --git a/docs/before.png b/docs/before.png