Skip to content

Commit

Permalink
chore: update readme - add warning about semver following
Browse files Browse the repository at this point in the history
  • Loading branch information
nd0ut committed Feb 1, 2023
1 parent 766d544 commit a52a3cf
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion get-started/installation/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Installation

## Breaking changes ⚠️

We don’t follow
<a href="https://semver.org/" target="_blank" rel="noopener noreferrer">
SemVer
</a>
during the beta phase. That means that we may introduce changes that break existing features
and functionality. It&rsquo;s important to pin your version and read
<a href="https://github.com/uploadcare/blocks/blob/main/CHANGELOG.md" target="_blank" rel="noopener noreferrer">
the changelog
</a>
before updating.

## Script tag approach

> We recommend to use the one of modern code distribution services, such as:
Expand Down Expand Up @@ -31,7 +44,7 @@ File uploader example:
First, install the npm package:

```sh
npm i @uploadcare/blocks
npm i --save-exact @uploadcare/blocks
```

Then use `connectBlocksFrom` function to connect blocks:
Expand Down

0 comments on commit a52a3cf

Please sign in to comment.