Skip to content

Commit 94e7257

Browse files
committed
docs: update package links from NuGet to GitHub Packages
1 parent 8ea04d6 commit 94e7257

File tree

3 files changed

+28
-11
lines changed

3 files changed

+28
-11
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55

66
An open-source SDK and scaffold for building BIM (Building Information Modeling) applications with .NET 9. Octopus provides reusable components, a REST API server, and client libraries to accelerate the development of custom BIM solutions.
77

8-
| Package | NuGet |
9-
|---------|-------|
10-
| Octopus.Blazor | [![NuGet](https://img.shields.io/nuget/v/Octopus.Blazor.svg?style=flat-square)](https://www.nuget.org/packages/Octopus.Blazor/) |
11-
| Octopus.Api.Client | [![NuGet](https://img.shields.io/nuget/v/Octopus.Api.Client.svg?style=flat-square)](https://www.nuget.org/packages/Octopus.Api.Client/) |
8+
| Package | GitHub Packages |
9+
|---------|-----------------|
10+
| Octopus.Blazor | [View Package](https://github.com/Ibrahim5aad/Octopus/pkgs/nuget/Octopus.Blazor) |
11+
| Octopus.Api.Client | [View Package](https://github.com/Ibrahim5aad/Octopus/pkgs/nuget/Octopus.Api.Client) |
1212

1313
![Octopus Viewer](screenshot.png)
1414

@@ -83,9 +83,15 @@ Octopus/
8383
For simple viewer applications without backend infrastructure:
8484

8585
```bash
86+
# Add GitHub Packages source (one-time setup)
87+
dotnet nuget add source https://nuget.pkg.github.com/Ibrahim5aad/index.json --name github --username YOUR_GITHUB_USERNAME --password YOUR_GITHUB_PAT
88+
89+
# Install the package
8690
dotnet add package Octopus.Blazor
8791
```
8892

93+
> **Note:** The `YOUR_GITHUB_PAT` needs `read:packages` scope. [Create a PAT here](https://github.com/settings/tokens).
94+
8995
Register services in `Program.cs`:
9096

9197
```csharp
@@ -127,6 +133,7 @@ In standalone mode, you can:
127133
For full BIM applications with model management, storage, and collaboration:
128134

129135
```bash
136+
# If you haven't added the GitHub Packages source yet (see Standalone Mode above)
130137
dotnet add package Octopus.Blazor
131138
dotnet add package Octopus.Api.Client
132139
```

src/Octopus.Api.Client/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# Octopus.Api.Client
22

3-
[![NuGet](https://img.shields.io/nuget/v/Octopus.Api.Client.svg?style=flat-square)](https://www.nuget.org/packages/Octopus.Api.Client/)
4-
[![NuGet Downloads](https://img.shields.io/nuget/dt/Octopus.Api.Client.svg?style=flat-square)](https://www.nuget.org/packages/Octopus.Api.Client/)
3+
[![GitHub Packages](https://img.shields.io/badge/GitHub%20Packages-Octopus.Api.Client-blue)](https://github.com/Ibrahim5aad/Octopus/pkgs/nuget/Octopus.Api.Client)
54
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
65

76
A typed HTTP client for the Octopus Server API. Use this package to connect your BIM applications to Octopus Server for model storage, processing, and management. Auto-generated from OpenAPI/Swagger specifications using NSwag.
87

9-
This package is required when using [Octopus.Blazor](https://www.nuget.org/packages/Octopus.Blazor/) in **Platform mode** (connected to Octopus Server). For standalone viewer applications without a backend, you only need Octopus.Blazor.
8+
This package is required when using [Octopus.Blazor](https://github.com/Ibrahim5aad/Octopus/pkgs/nuget/Octopus.Blazor) in **Platform mode** (connected to Octopus Server). For standalone viewer applications without a backend, you only need Octopus.Blazor.
109

1110
## Features
1211

@@ -18,9 +17,15 @@ This package is required when using [Octopus.Blazor](https://www.nuget.org/packa
1817
## Installation
1918

2019
```bash
20+
# Add GitHub Packages source (one-time setup)
21+
dotnet nuget add source https://nuget.pkg.github.com/Ibrahim5aad/index.json --name github --username YOUR_GITHUB_USERNAME --password YOUR_GITHUB_PAT
22+
23+
# Install the package
2124
dotnet add package Octopus.Api.Client
2225
```
2326

27+
> **Note:** The `YOUR_GITHUB_PAT` needs `read:packages` scope. [Create a PAT here](https://github.com/settings/tokens).
28+
2429
## Quick Start
2530

2631
### Basic Setup
@@ -159,4 +164,4 @@ MIT
159164

160165
## Related Packages
161166

162-
- [Octopus.Blazor](https://www.nuget.org/packages/Octopus.Blazor/) - Blazor component library for 3D BIM visualization
167+
- [Octopus.Blazor](https://github.com/Ibrahim5aad/Octopus/pkgs/nuget/Octopus.Blazor) - Blazor component library for 3D BIM visualization

src/Octopus.Blazor/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Octopus.Blazor
22

3-
[![NuGet](https://img.shields.io/nuget/v/Octopus.Blazor.svg?style=flat-square)](https://www.nuget.org/packages/Octopus.Blazor/)
4-
[![NuGet Downloads](https://img.shields.io/nuget/dt/Octopus.Blazor.svg?style=flat-square)](https://www.nuget.org/packages/Octopus.Blazor/)
3+
[![GitHub Packages](https://img.shields.io/badge/GitHub%20Packages-Octopus.Blazor-blue)](https://github.com/Ibrahim5aad/Octopus/pkgs/nuget/Octopus.Blazor)
54
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
65

76
A Blazor component library for building BIM (Building Information Modeling) applications. Wraps the [@xbim/viewer](https://www.npmjs.com/package/@xbim/viewer) JavaScript library for 3D model visualization in Blazor WebAssembly or Server applications.
@@ -28,9 +27,15 @@ This library supports two modes to fit different application needs:
2827
## Installation
2928

3029
```bash
30+
# Add GitHub Packages source (one-time setup)
31+
dotnet nuget add source https://nuget.pkg.github.com/Ibrahim5aad/index.json --name github --username YOUR_GITHUB_USERNAME --password YOUR_GITHUB_PAT
32+
33+
# Install the package
3134
dotnet add package Octopus.Blazor
3235
```
3336

37+
> **Note:** The `YOUR_GITHUB_PAT` needs `read:packages` scope. [Create a PAT here](https://github.com/settings/tokens).
38+
3439
For platform mode, also install the API client:
3540

3641
```bash
@@ -309,4 +314,4 @@ MIT
309314

310315
## Related Packages
311316

312-
- [Octopus.Api.Client](https://www.nuget.org/packages/Octopus.Api.Client/) - API client for Octopus Server
317+
- [Octopus.Api.Client](https://github.com/Ibrahim5aad/Octopus/pkgs/nuget/Octopus.Api.Client) - API client for Octopus Server

0 commit comments

Comments
 (0)