Skip to content

Update readme documentation #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jsturtevant merged 6 commits into from
May 2, 2026
Merged

Update readme documentation #72

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
50c53ec
Initial plan
Copilot May 2, 2026
302f223
Update README with dotnet add package install instructions and AddPyt…
Copilot May 2, 2026
7924365
Use existing WithPythonModule() extension method; remove AddPythonModule
Copilot May 2, 2026
0a88226
Drop redundant module= argument from README Python Quick Start
Copilot May 2, 2026
20e827d
Remove --version <VERSION> from .NET install commands in README
Copilot May 2, 2026
2f9c0dc
Restore module= argument in README Python Quick Start
Copilot May 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,16 +81,17 @@ print(result.stdout)

.NET SDK:

```bash
just wasm guest-build # build the guest module
just dotnet build # build the .NET SDK
```shell
dotnet add package Hyperlight.HyperlightSandbox.Api
dotnet add package Hyperlight.HyperlightSandbox.Guest.Python
Comment thread
jsturtevant marked this conversation as resolved.
```

```csharp
using HyperlightSandbox.Api;
using HyperlightSandbox.Guest.Python;

using var sandbox = new SandboxBuilder()
.WithModulePath("python-sandbox.aot")
.WithPythonModule()
.Build();

sandbox.RegisterTool<MathArgs, double>("add", args => args.a + args.b);
Expand Down