Skip to content

docs: add NuGet installation instructions to README#57

Merged
dexcompiler merged 2 commits intomainfrom
copilot/update-readme-installation-section
Apr 8, 2026
Merged

docs: add NuGet installation instructions to README#57
dexcompiler merged 2 commits intomainfrom
copilot/update-readme-installation-section

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 8, 2026

README had no guidance on how to add the package, despite Clockworks being published on NuGet.

Changes

  • README.md: Added ## Installation section between Features and Quick start with the standard .NET CLI install command:
dotnet add package Clockworks
Original prompt

Update the README in repository dexcompiler/Clockworks to include NuGet installation instructions for the existing Clockworks package.

Requirements

  1. Add a clear “Installation” (or similarly named) section to README that includes the standard .NET CLI package install command:
dotnet add package Clockworks
  1. Do not add unnecessary external links unless they are already part of README style. The user explicitly stated the CLI install command is sufficient.

  2. Run/validate the codebase and check for README alignment issues:

    • Verify documented build/run/test steps are accurate with the current codebase.
    • If README is missing obvious required setup steps discovered during validation, update it minimally and accurately.
    • Keep changes focused and pragmatic; avoid broad documentation rewrites.
  3. Ensure edits are concise, professional, and consistent with existing README tone and structure.

  4. Open a pull request against main from a new working branch with:

    • A clear title summarizing README improvements.
    • A description that includes:
      • What changed in README.
      • Any validation/run commands executed.
      • Any additional README alignment adjustments made and rationale.

Acceptance criteria

  • README contains dotnet add package Clockworks in an appropriate installation section.
  • Any discovered doc/code mismatch relevant to getting started is corrected.
  • PR is created targeting main.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: currently the README section says nothing about the getting the Clockworks package from nuget. The package already exists at nuget: https://www.nuget.org/packages/Clockworks/ so we need that reflected in the README. Also run the codebase to see if there some README alignment is needed. You can start the agent.

Assistant: Absolutely — I can do that, and I’ll keep the response quality at a senior/staff-engineer level as requested.

I can start the coding agent, but first I need one clarification to execute correctly:

  • Which base branch should the PR target in dexcompiler/Clockworks (e.g., main)?

Once you confirm the base branch, I’ll start the agent to:

  1. Update the README with NuGet installation/usage for Clockworks (linking to https://www.nuget.org/packages/Clockworks/).
  2. Run/validate the codebase and identify any additional README alignment gaps (build/run/test/docs drift).
  3. Open a PR with a clear changelog of what was updated and why.

User: you don't necessarily have to link to the nuget itself. just the standard dotnet add package Clockworks should be sufficient I think.

Assistant: Great call — agreed. Adding the standard install command is the right minimal UX:

  • dotnet add package Clockworks

I’m ready to start the PR agent now for dexcompiler/Clockworks, but I still need the target base branch (for example, main or master) before I can open the PR.

User: target branch is main. you can create your own branch to work on this. proceed.

Assistant: Done — I’ve kicked things off and we’re now waiting on your confirmation in the GitHub dialog to continue.

This pull request was created from Copilot chat.

Copilot AI changed the title [WIP] Update README to include NuGet installation instructions for Clockworks docs: add NuGet installation instructions to README Apr 8, 2026
Copilot AI requested a review from dexcompiler April 8, 2026 03:05
@dexcompiler dexcompiler marked this pull request as ready for review April 8, 2026 03:11
@dexcompiler dexcompiler merged commit e2541f9 into main Apr 8, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants