Skip to content
This repository has been archived by the owner on Jan 27, 2025. It is now read-only.

Commit

Permalink
chore: update README with archiving repository message
Browse files Browse the repository at this point in the history
  • Loading branch information
emanuelgsouza committed Jan 22, 2025
1 parent 672ddd7 commit f4da836
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,28 @@

This Design System is an open-source collection of components that are used in app.storyblok.com and is continiously developed to improve Storyblok.

## Important Announcement: This Repository Will Be Archived

We want to inform you that this repository, will be archived on 2025-01-27. This means the repository will remain publicly accessible in a read-only state, but we will no longer actively maintain or update it for the foreseeable future. This also means that we will not update the NPM package.

### Why Is This Happening?

As our focus and priorities evolve, we’ve decided to pause active development on the public Design System. While this decision wasn’t made lightly, it allows us to direct our resources to other initiatives.

### What Does Archiving Mean?

- **Read-Only Access**: You’ll still be able to clone, fork, and view the repository’s contents.
- **No Updates or Support**: We won’t be addressing issues, reviewing pull requests, or providing updates.
- **Preservation of Content**: The repository will remain available to reference as-is for historical and educational purposes.

If you have questions or concerns, feel free to reach out via our support channels.

## Demo

You can see the Design System live under <https://next.blok.ink>

## Compatibility
## Compatibility

The `@storyblok/design-system` package is compatible with Vue 3 only. For Vue 2, please use the `storyblok-design-system` package.

## Getting started
Expand All @@ -23,7 +40,7 @@ Then you need to install and use the Design System in your Vue project:
```js
import BlokInk from '@storyblok/design-system'
import '@storyblok/design-system/dist/storyblok-design-system.css'

app.use(BlokInk) // vue 3
```

Expand All @@ -38,47 +55,48 @@ Then you can use all Blok.Ink components everywhere in your app.
### Only install specific components

You can also only install a few components, by specifying the option `withComponents`.

```js
import BlokInk from '@storyblok/design-system'
import '@storyblok/design-system/dist/storyblok-design-system.css'

app.use(BlokInk, {
withComponents: [
'SbButton',
'SbIcon',
]
withComponents: ['SbButton', 'SbIcon'],
})
```


For more information on the usage of the Design System go to:
[https://www.storyblok.com/docs/guide/in-depth/design-system](https://www.storyblok.com/docs/guide/in-depth/design-system)

## Development

To develop within the Design System you can use Storybook that has all components setup:

### Start & Execute Storybook

```sh
yarn # or npm install
yarn storybook
```

### Compiles and minifies for production

```sh
yarn build
```

### Run your unit tests

```sh
yarn test:unit
```

### Lints and fixes files

```sh
yarn lint
```


---

<p align="center">
Expand Down

0 comments on commit f4da836

Please sign in to comment.