Skip to content

Commit aca174c

Browse files
committed
docs(readme): explain how to run the application from npm and docker hub
1 parent b5b6b01 commit aca174c

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,42 @@ yarn test
103103
104104
## 🚀 Deployment <a name = "deployment"></a>
105105

106-
We automatically build and deploy the latest version and all [releases](https://github.com/Addono/container-registry-proxy/releases) to:
106+
We automatically build and deploy all [releases](https://github.com/Addono/container-registry-proxy/releases) to:
107107

108108
- [NPM](https://www.npmjs.com/package/container-registry-proxy)
109109
- [Docker Hub](https://hub.docker.com/r/addono/container-registry-proxy)
110110

111+
### NPM
112+
113+
Install the application locally:
114+
115+
```bash
116+
# Install globally in NPM
117+
npm install -g container-registry-proxy
118+
119+
# Install globally in Yarn
120+
yarn global add container-registry-proxy
121+
```
122+
123+
Start the proxy:
124+
125+
```bash
126+
# Full command
127+
container-registry-proxy
128+
129+
# A short name is also available
130+
crp
131+
132+
# Configuration is done using environment variables
133+
PORT=80 container-registry-proxy
134+
```
135+
136+
### Docker
137+
138+
```bash
139+
docker run --rm -it -p 8080:8080 --name crp addono/container-registry-proxy
140+
```
141+
111142
## ✨ Contributors <a name = "contributors"></a>
112143

113144
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

0 commit comments

Comments
 (0)