Skip to content
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.

Commit

Permalink
Update README (#7)
Browse files Browse the repository at this point in the history
* update readme

* fix links

Co-authored-by: Elise Yang <[email protected]>
  • Loading branch information
elisenyang and Elise Yang committed Oct 17, 2022
1 parent ffd44dd commit a3bda06
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Hydrogen-UI
<div align="center">

The monorepo for the Hydrogen-UI library; each package can be found in the `./packages` folder.
# Hydrogen UI

## Versioning
<a href="https://github.com/Shopify/hydrogen-ui/blob/2022-7/LICENSE.md"><img src="https://img.shields.io/npm/l/@shopify/hydrogen.svg?sanitize=true" alt="License"></a>

Hydrogen UI is a library of reusable components and utilities for building Shopify-powered custom storefronts.

**Note:** Hydrogen UI is currently available as an experimental (beta) feature and functionality is subject to change.

📚 [Docs](https://shopify.dev/custom-storefronts/hydrogen/alternate-frameworks) | 🗣 [Discord](https://discord.gg/Hefq6w5c5d) | 📝 [Changelog](./packages/react/CHANGELOG.md) | 🖼 [Hydrogen Framework](https://github.com/Shopify/hydrogen)

**Hydrogen UI doesn't follow semantic versioning**.
</div>

## Packages

- [`@shopify/hydrogen-react`](./packages/react/)

## Versioning

Hydrogen UI is tied to specific versions of the [Shopify Storefront API](https://shopify.dev/api/storefront), which follow [calver](https://calver.org/).
Hydrogen UI is tied to specific versions of the [Shopify Storefront API](https://shopify.dev/api/storefront), which follows [calver](https://calver.org/).

For example, if you're using Storefront API version `2022-07`, then Hydrogen UI versions `2022.7.x` are fully compatible.

Expand Down

0 comments on commit a3bda06

Please sign in to comment.