diff --git a/.npmrc b/.npmrc index ee6f74433daf877282f132b97785487dddb71254..c528b7612fdea549b70f5da7d49cfab6052e8bc9 100644 --- a/.npmrc +++ b/.npmrc @@ -1,3 +1,3 @@ -@a-distributed-data-revisioning-system-for-the-iop:registry:registry=https://git.rwth-aachen.de/api/v4/packages/npm/ +@i5:registry:registry=https://git.rwth-aachen.de/api/v4/packages/npm/ //git.rwth-aachen.de//api/v4/packages/npm/:_authToken=${CI_JOB_TOKEN} //git.rwth-aachen.de/api/v4/projects/37731/packages/npm/:_authToken=${CI_JOB_TOKEN} diff --git a/README.md b/README.md index 73da76b6c1f177b2cb178a0f0428c9676dc9e57b..e5cca98855ee58257cb749523d442c6131651187 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,21 @@ They should point to an existing Trellis instance. #### Import factlib.js Gitlab users with access to the project repository can load the library from the npm registry as a dependency using ``` -npm install @a-distributed-data-revisioning-system-for-the-iop/factlib.js +npm install @i5/factlib.js ``` -A list of the available versions can be found in the [Packages](https://git.rwth-aachen.de/a-distributed-data-revisioning-system-for-the-iop/factlibjs/-/packages) +A list of the available versions can be found in the [Packages](https://git.rwth-aachen.de/i5/factdag/factlibjs/-/packages) section in Gitlab. To authenticate, a `.npmrc` file must be present containing: ``` -@a-distributed-data-revisioning-system-for-the-iop:registry=https://git.rwth-aachen.de/api/v4/packages/npm/ +@i5:registry=https://git.rwth-aachen.de/api/v4/packages/npm/ //git.rwth-aachen.de/api/v4/packages/npm/:_authToken=<TOKEN> ``` The `<TOKEN>` can be a personal access token that can be created in the user settings in Gitlab. The [Gitlab-Documentation](https://git.rwth-aachen.de/help/user/packages/npm_registry/index.md) contains further details. The library can then be imported like this: ``` -import {Fact} from "@a-distributed-data-revisioning-system-for-the-iop/factlib.js"; +import {Fact} from "@i5/factlib.js"; ``` #### Modify RDF resources Factlib.js uses [rdflib.js](https://github.com/linkeddata/rdflib.js) to store LDP resources locally. @@ -55,5 +55,5 @@ There are multiple examples that show how the library can be used. The pipeline create a revision of a process fact in an LDP and stores the URI of the current commit with it. ### Documentation -The [TypeDoc Documentation](https://a-distributed-data-revisioning-system-for-the-iop.pages.rwth-aachen.de/factlibjs/) +The [TypeDoc Documentation](https://i5.pages.rwth-aachen.de/factdag/factlibjs) documents the functions and classes that are provided by factlib.js. \ No newline at end of file diff --git a/package.json b/package.json index 13329dd6dd8b74696ce458cef8a811c0eeb1cde4..3361f57c5e1411a7869ac7eb7823a8056b3c1312 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@a-distributed-data-revisioning-system-for-the-iop/factlib.js", + "name": "@i5/factlib.js", "version": "0.0.1", "description": "Enables clients and processes to interact with Linked Data Platforms according to the FactDAG model while preserving and creating correct provenance information.", "main": "dist/index.js", @@ -14,7 +14,7 @@ "license": "", "repository": { "type" : "git", - "url" : "https://git.rwth-aachen.de/a-distributed-data-revisioning-system-for-the-iop/factlibjs.git" + "url" : "https://git.rwth-aachen.de/i5/factdag/factlibjs" }, "dependencies": { "@rdfjs/parser-jsonld": "^1.1.2", @@ -33,6 +33,6 @@ "typescript": "^3.7.2" }, "publishConfig": { - "@a-distributed-data-revisioning-system-for-the-iop:registry": "https://git.rwth-aachen.de/api/v4/projects/37731/packages/npm/" + "@i5:registry": "https://git.rwth-aachen.de/api/v4/projects/37731/packages/npm/" } }