imgix-url-builder/README.md

JavaScript/TypeScript Imgix URL builders for browsers and Node.js

<!--

TODO: Go through all "TODO" comments in the project

-->

# imgix-url-builder

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
[![License][license-src]][license-href]

> ⚠ This project is in an experimental state. Use it at your own risks or stay tuned for the official release!

<!-- TODO: Replacing link to Prismic with [Prismic][prismic] is useful here -->

JavaScript/TypeScript Imgix URL builders for browsers and Node.js.

<!--

TODO: Create a small list of package features:

- 🤔 &nbsp;A useful feature;
- 🥴 &nbsp;Another useful feature;
- 🙃 &nbsp;A final useful feature.

Non-breaking space: &nbsp; are here on purpose to fix emoji rendering on certain systems.

-->

## Install

```bash
npm install imgix-url-builder
```

## Documentation

To discover what's new on this package check out [the changelog][changelog]. Documentation is not yet available.

<!-- TODO: Write or link to documentation. -->

## Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

**Asking a question**: [Open an issue][repo-bug-report] explaining what you want to achieve / your question. A maintainer will get back to you shortly.

**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.

**Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.

**Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.

For more clarity on this project and its structure you can also check out the detailed [CONTRIBUTING.md][contributing] document.

## License

```
   Copyright 2013-2021 Prismic <contact@prismic.io> (https://prismic.io)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
```

<!-- Links -->

[prismic]: https://prismic.io

<!-- TODO: Replace link with a more useful one if available -->

[prismic-docs]: https://prismic.io/docs
[changelog]: ./CHANGELOG.md
[contributing]: ./CONTRIBUTING.md

<!-- TODO: Replace link with a more useful one if available -->

[forum-question]: https://community.prismic.io
[repo-bug-report]: https://github.com/prismicio-community/imgix-url-builder/issues/new?assignees=&labels=bug&template=bug_report.md&title=
[repo-feature-request]: https://github.com/prismicio-community/imgix-url-builder/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
[repo-pull-requests]: https://github.com/prismicio-community/imgix-url-builder/pulls

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/imgix-url-builder/latest.svg
[npm-version-href]: https://npmjs.com/package/imgix-url-builder
[npm-downloads-src]: https://img.shields.io/npm/dm/imgix-url-builder.svg
[npm-downloads-href]: https://npmjs.com/package/imgix-url-builder
[github-actions-ci-src]: https://github.com/prismicio-community/imgix-url-builder/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/prismicio-community/imgix-url-builder/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/prismicio-community/imgix-url-builder.svg
[codecov-href]: https://codecov.io/gh/prismicio-community/imgix-url-builder
[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
[conventional-commits-href]: https://conventionalcommits.org
[license-src]: https://img.shields.io/npm/l/imgix-url-builder.svg
[license-href]: https://npmjs.com/package/imgix-url-builder