Skip to content
Snippets Groups Projects
Verified Commit f1b63192 authored by Jan Loewe's avatar Jan Loewe :speech_balloon:
Browse files

docs(readme): improve installation section

parent ed275376
Branches
Tags
No related merge requests found
Pipeline #22132 passed
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment