diff --git a/README.md b/README.md index a3ec985..5f41068 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,45 @@
-# @wolfstar/plugins +WolfStar Logo -**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)
-## 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) | -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. -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 + + Contributors + -Apache-2.0 © WolfStar Project +[contributing]: https://github.com/wolfstar-project/plugins/blob/main/.github/CONTRIBUTING.md