From d362d1cabff962e379f4e3b21e3038fe3a33eada Mon Sep 17 00:00:00 2001 From: hitchhiker Date: Wed, 16 Apr 2025 22:15:05 +0200 Subject: [PATCH] fixes: documentation --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c72d4d3..85fd59d 100644 --- a/README.md +++ b/README.md @@ -69,8 +69,25 @@ echo "//git.generation.one/api/packages/GenerationOne/npm/:_authToken=${GITEA_TO # Install the package pnpm add @g1/sse-client -# Alternatively, you can install directly from the public GitHub repository: -pnpm add git+https://git.generation.one/GenerationOne/g1-ts-common-packages.git#packages/sse-client +# Alternatively, you can install directly from the public repository: +pnpm add git+https://git.generation.one/GenerationOne/g1-ts-common-packages.git + +# Or clone the repository and link it locally: +git clone https://git.generation.one/GenerationOne/g1-ts-common-packages.git +cd g1-ts-common-packages +pnpm install +pnpm build +cd packages/sse-client +pnpm link . + +# Another option is to create a tarball and install it directly: +git clone https://git.generation.one/GenerationOne/g1-ts-common-packages.git +cd g1-ts-common-packages/packages/sse-client +pnpm install +pnpm build +pnpm pack # Creates a tarball like g1-sse-client-0.2.0.tgz +# Then in your project: +pnpm add /path/to/g1-sse-client-0.2.0.tgz ``` ### Example Usage