Skip to content

docs: align README with stars-components layout #3

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
RedStar071 merged 1 commit into from
Jul 5, 2026
Merged

docs: align README with stars-components layout #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
61 changes: 26 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,54 +1,45 @@
<div align="center">

# @wolfstar/plugins
<img src="https://cdn.wolfstar.rocks/wolfstar-assets/wolfstar.png" alt="WolfStar Logo" width="100px" />

**A monorepo of official plugins for [`@wolfstar/http-framework`](https://www.npmjs.com/package/@wolfstar/http-framework).**
# Plugins

Structured after [`sapphiredev/plugins`](https://github.com/sapphiredev/plugins), tooled after
[`wolfstar-project/stars-components`](https://github.com/wolfstar-project/stars-components).
**Official plugins for [`@wolfstar/http-framework`](https://www.npmjs.com/package/@wolfstar/http-framework)**

[![GitHub License](https://img.shields.io/github/license/wolfstar-project/plugins?style=flat-square)](https://github.com/wolfstar-project/plugins/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/wolfstar-project/plugins/branch/main/graph/badge.svg)](https://codecov.io/gh/wolfstar-project/plugins)

</div>

## Packages
---

| Package | Description |
| ----------------------------------------------- | ------------------------------------------------------------ |
| [`@wolfstar/plugin-api`](./packages/plugin-api) | Registers a standalone REST API server for auxiliary routes. |
## Packages

## Development
| Package | Version | Downloads |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| [`@wolfstar/plugin-api`](https://npmx.dev/package/@wolfstar/plugin-api) | [![version](https://npmx.dev/api/registry/badge/version/@wolfstar/plugin-api)](https://npmx.dev/package/@wolfstar/plugin-api) | [![downloads](https://npmx.dev/api/registry/badge/downloads/@wolfstar/plugin-api)](https://npmx.dev/package/@wolfstar/plugin-api) |

@greptile-apps greptile-apps Bot Jul 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Package Badges Point Nowhere

The package table now relies on the external npmx/npm page for @wolfstar/plugin-api instead of the local package path. If that package has not been published yet, the README's only package row shows broken or empty version/download badges and sends readers away from the source package that exists in this repo.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: README.md
Line: 20

Comment:
**Package Badges Point Nowhere**

The package table now relies on the external npmx/npm page for `@wolfstar/plugin-api` instead of the local package path. If that package has not been published yet, the README's only package row shows broken or empty version/download badges and sends readers away from the source package that exists in this repo.

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code Fix in Cursor Fix in Cursor Cloud Agents


This monorepo uses **pnpm** workspaces + **Turborepo**.
---

```bash
pnpm install # install dependencies
pnpm build # build every package with tsdown
pnpm typecheck # type-check every package
pnpm test # run vitest
pnpm lint # oxlint + oxfmt --check
pnpm lint:fix # oxlint --fix + oxfmt
pnpm knip # detect unused code / dependencies
```
## Open in your editor

### Tooling
Want to contribute without setting up locally? Click any button below to open this project in a cloud development environment:

- **Package manager:** pnpm 11
- **Build:** tsdown
- **Lint / format:** oxlint + oxfmt
- **Task runner:** Turborepo
- **Commit hooks:** husky + nano-staged + commitlint (conventional commits)
- **Versioning / release:** Changesets
[![Open in VS Code](https://img.shields.io/badge/Open%20in-VS%20Code-007ACC?style=flat-square&logo=visualstudiocode)](https://vscode.dev/github/wolfstar-project/plugins)
[![Open in GitHub Codespaces](https://img.shields.io/badge/Open%20in-GitHub%20Codespaces-181717?style=flat-square&logo=github)](https://codespaces.new/wolfstar-project/plugins)
[![Open in StackBlitz](https://img.shields.io/badge/Open%20in-StackBlitz-1269D3?style=flat-square&logo=stackblitz)](https://stackblitz.com/github/wolfstar-project/plugins)
[![Open in Gitpod](https://img.shields.io/badge/Open%20in-Gitpod-FFB45B?style=flat-square&logo=gitpod)](https://gitpod.io/#https://github.com/wolfstar-project/plugins)

## Releasing
---

Add a changeset for every user-facing change:
## Contributing

```bash
pnpm changeset
```
Please read the [Contributing Guide][contributing] before submitting a pull request.

@greptile-apps greptile-apps Bot Jul 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Contributing Path Leaves Repository

This README now makes .github/CONTRIBUTING.md the contributor entry point after removing the local setup and release sections. That guide's pull-request link targets the stars-components repository, so contributors following the new README path can end up opening or looking for PRs in the wrong project.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: README.md
Line: 38

Comment:
**Contributing Path Leaves Repository**

This README now makes `.github/CONTRIBUTING.md` the contributor entry point after removing the local setup and release sections. That guide's pull-request link targets the `stars-components` repository, so contributors following the new README path can end up opening or looking for PRs in the wrong project.

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code Fix in Cursor Fix in Cursor Cloud Agents

On merge to `main`, the `release` workflow opens a "version packages" PR (via Changesets). Merging that PR
publishes the affected packages to npm with provenance.
Thank you to all the people who have already contributed to Plugins!

## License
<a href="https://github.com/wolfstar-project/plugins/graphs/contributors">
<img src="https://contrib.rocks/image?repo=wolfstar-project/plugins" alt="Contributors" />
</a>

Apache-2.0 © WolfStar Project
[contributing]: https://github.com/wolfstar-project/plugins/blob/main/.github/CONTRIBUTING.md
Loading