Skip to content

Improve README installation docs with LLM guide and bunx @latest#9

Merged
fetep merged 3 commits into
mainfrom
petef/dev
Mar 18, 2026
Merged

Improve README installation docs with LLM guide and bunx @latest#9
fetep merged 3 commits into
mainfrom
petef/dev

Conversation

@fetep

@fetep fetep commented Mar 18, 2026

Copy link
Copy Markdown
Owner

Changes

  • docs: add LLM-guided installation instructions to README
  • docs: recommend global install for tmux binding, add @latest to bunx
  • fix(ci): remove changelog header and deduplicate entry
  • chore: release v0.2.0
  • ci: replace npm pack check with npm pkg fix idempotency check
  • chore: add fetch + rebase step to /pr command
  • fix(ci): narrow npm pack check to publish warnings only

Copilot AI review requested due to automatic review settings March 18, 2026 20:32
@fetep fetep merged commit cb1caa2 into main Mar 18, 2026
7 checks passed
@fetep fetep deleted the petef/dev branch March 18, 2026 20:33

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates user-facing installation documentation to include an LLM-guided install path and standardize “latest” install recommendations, while adjusting release/changelog automation to avoid duplicated entries and remove the changelog H1 header.

Changes:

  • README: add an “Install with your LLM” section and update bunx/npx examples to use @latest, plus recommend global install for tmux bindings.
  • CHANGELOG: remove a duplicated entry and remove the # Changelog header.
  • Release workflow: when generating a new CHANGELOG.md, copy release notes directly instead of writing a # Changelog header.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
README.md Adds LLM-oriented install guidance and updates install/tmux instructions to prefer @latest and global pulse.
CHANGELOG.md Deduplicates an entry and removes the H1 changelog header.
.github/workflows/release.yml Adjusts changelog generation to avoid inserting # Changelog when creating the file.
Comments suppressed due to low confidence (1)

README.md:101

  • This section says to add opencode-pulse to the OpenCode config, but the example immediately below uses opencode-pulse@latest. Please align the prose with the recommended config value to avoid users adding the wrong entry.
Add `opencode-pulse` to your OpenCode config (`~/.config/opencode/opencode.json` or `~/.config/opencode/opencode.jsonc`):

```jsonc
{
  "plugin": ["opencode-pulse@latest"]
}

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment thread README.md
Comment on lines +43 to +46
Read the existing config:
```bash
cat ~/.config/opencode/opencode.json 2>/dev/null || cat ~/.config/opencode/opencode.jsonc 2>/dev/null || echo "no-config"
```
Comment thread README.md
Preserve all other config entries.
- If no config exists: create ~/.config/opencode/opencode.json with:
{ "plugin": ["opencode-pulse@latest"] }
- If "opencode-pulse" is already in the plugin array: skip this step.
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