From f1b63192c562b08627bf59adaad0b9673e3d9b8b Mon Sep 17 00:00:00 2001 From: Jan Loewe <jan.loewe@ptb.de> Date: Wed, 14 Jun 2023 11:26:29 +0200 Subject: [PATCH] docs(readme): improve installation section --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 68383fb..3bfbd82 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,35 @@ If you are looking for a way to validate xml against a xsd in the browser, have ## Getting Started -The module is currently published to a private registry on this GitLab instance. +The module is currently published to a public registry on this GitLab instance. + +<details> + <summary><b>npm</b> Instructions</summary> + To install it you have to create a `.npmrc` in the root of your project with the following content. ``` @d-ptb:registry=https://gitlab1.ptb.de/api/v4/packages/npm/ - -# the following auth token is a public read only one -//gitlab1.ptb.de/api/v4/projects/:_authToken=yyhHC6-HhSZ8zxu4BS-_ -//gitlab1.ptb.de/api/v4/packages/npm/:_authToken=yyhHC6-HhSZ8zxu4BS-_ -//gitlab1.ptb.de/api/v4/projects/105/packages/npm/:_authToken=yyhHC6-HhSZ8zxu4BS-_ ``` After that you can run `npm install @d-ptb/dcc-js`. +</details> + +<details> + <summary><b>yarn</b> Instructions</summary> + +To install it you have to create a `.yarnrc.yml` in the root of your project with the following content. + +``` +npmScopes: + d-ptb: + npmRegistryServer: "https://gitlab1.ptb.de/api/v4/packages/npm/" +``` + +After that you can run `yarn add @d-ptb/dcc-js`. + +</details> ## Example -- GitLab