diff --git a/README.md b/README.md index 31ccc2b..99f7cd6 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,24 @@ + +

postcss-licensing

Prepends licensing or other metadata to CSS files.

-
+

-[![Tests](https://github.com/allonsy-studio/postcss-licensing/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/allonsy-studio/postcss-licensing/actions/workflows/testing.yml) -[![NPM version](https://img.shields.io/npm/v/postcss-licensing.svg)](https://www.npmjs.com/package/postcss-licensing) + + Tests + + + NPM version + + +

-
## Installation @@ -73,17 +80,42 @@ postcss([ ``` + + +## Releasing with changesets + +Releases are managed by [Changesets](https://github.com/changesets/changesets). When you make a change that affects how the action behaves for consumers, add a changeset: + +```bash +yarn changeset +``` + +Pick the bump type when prompted, write a short summary, and commit the generated file in `.changeset/` alongside your code: + +- **patch** — bug fixes +- **minor** — new, backwards-compatible features +- **major** — breaking changes + +Changes that don't affect consumers (docs, tests, CI, internal refactors) don't need a changeset. + + -## Contributing +

Contributing

-Contributions are welcome! Please open an [issue](https://github.com/allonsy-studio/glob-concat-cli/issues/new) or submit a pull request. +Contributions are welcome and appreciated! Please open an [issue](https://github.com/allonsy-studio/postcss-licensing/issues/new) (before submitting a pull request) if you find a bug, have a feature request, or have a question. Be sure to follow the [contribution guidelines](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md) but most importantly, be excellent to each other. 💖 + + +

License

+ +This project is licensed under the MPL-2.0 License - see the [LICENSE](LICENSE) file for details. This means you can use this freely, modify as needed; changes to MPL-licensed files should be shared back under the same license. +