Skip to content

Clarify usage section and add redistribution restriction to README#1

Closed
nickwinder wants to merge 1 commit intomainfrom
nick/docs/readme-usage-and-licensing
Closed

Clarify usage section and add redistribution restriction to README#1
nickwinder wants to merge 1 commit intomainfrom
nick/docs/readme-usage-and-licensing

Conversation

@nickwinder
Copy link
Copy Markdown

Why

README lacked clarity on two points: the Usage section only covered CLI commands despite the skill-based install being the recommended path, and there was no mention of redistribution restrictions despite the license being non-transferable.

Summary

  • Restructured Usage section into "Via agent skill" and "Via CLI" subsections, with a concrete extraction-focused example prompt for the skill path
  • Added redistribution restriction bullet to Trust and Licensing, noting the binary cannot be redistributed standalone or sublicensed

@nickwinder nickwinder self-assigned this Apr 2, 2026
jdrhyne added a commit that referenced this pull request Apr 2, 2026
Add a concrete prompt example showing what the agent skill experience
looks like once installed. Add non-transferable/redistribution bullet
to Trust and Licensing section.

Incorporates improvements suggested in #1.
@jdrhyne
Copy link
Copy Markdown
Contributor

jdrhyne commented Apr 2, 2026

Both improvements from this PR have been incorporated into main via 99aa4b5:

  • Agent skill usage example: Added a concrete prompt example ("Extract the pricing table from proposal.pdf") to the Install section, showing what the skill experience looks like once installed.
  • Redistribution restriction: Added the non-transferable/redistribution bullet to Trust and Licensing.

The usage section structure differs from this PR — we moved the agent skill to be the primary install method rather than a subsection under Usage, which puts it higher in the README. Closing in favor of the merged approach.

@jdrhyne jdrhyne closed this Apr 2, 2026
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