From 4300df43ffc7e35c901a4fa472d0ebf4e84325c2 Mon Sep 17 00:00:00 2001 From: Daniel N <2color@users.noreply.github.com> Date: Fri, 26 Jul 2024 11:43:48 +0200 Subject: [PATCH] fix: case sensitive typo in README --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a24c91d..955fbb3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -ipfs-check -======================= +# ipfs-check > Check if you can find your content on IPFS @@ -7,12 +6,12 @@ A tool for checking the accessibility of your data by IPFS peers ## Documentation - ### Build `go build` will build the server binary in your local directory ### Install + `go install` will build and install the server binary in your global Go binary directory (e.g. `~/go/bin`) ### Deploy @@ -23,6 +22,7 @@ Maybe just deploy it on IPFS and reference it with DNSLink. For anything other than local testing you're going to want to have a proxy to give you HTTPS support on the Go server. When deploying to prod, since the addition of telemetry (https://github.com/ipfs-shipyard/ipfs-check/pull/30) you will also need to run the following before serving the web assets: + ``` cd web npm install && npm run build @@ -42,16 +42,18 @@ docker run -d ipfs-check ## Running locally ### Terminal 1 + ``` go build ./ipfs-check # Note listening port.. output should say something like "listening on [::]:3333" ``` ### Terminal 2 + ``` # feel free to use any other tool to serve the contents of the /web folder (you can open the html file directly in your browser) npx -y serve -l 3000 web -# Then open http://localhost:3000?backendUrl=http://localhost:3333 +# Then open http://localhost:3000?backendURL=http://localhost:3333 ``` ## License