fixes: documentation
This commit is contained in:
parent
a277fb6b60
commit
d362d1cabf
21
README.md
21
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
|
||||
|
Loading…
x
Reference in New Issue
Block a user