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

Commit f4da836

Browse files
committed
chore: update README with archiving repository message
1 parent 672ddd7 commit f4da836

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,28 @@
22

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

5+
## Important Announcement: This Repository Will Be Archived
6+
7+
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.
8+
9+
### Why Is This Happening?
10+
11+
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.
12+
13+
### What Does Archiving Mean?
14+
15+
- **Read-Only Access**: You’ll still be able to clone, fork, and view the repository’s contents.
16+
- **No Updates or Support**: We won’t be addressing issues, reviewing pull requests, or providing updates.
17+
- **Preservation of Content**: The repository will remain available to reference as-is for historical and educational purposes.
18+
19+
If you have questions or concerns, feel free to reach out via our support channels.
20+
521
## Demo
622

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

9-
## Compatibility
25+
## Compatibility
26+
1027
The `@storyblok/design-system` package is compatible with Vue 3 only. For Vue 2, please use the `storyblok-design-system` package.
1128

1229
## Getting started
@@ -23,7 +40,7 @@ Then you need to install and use the Design System in your Vue project:
2340
```js
2441
import BlokInk from '@storyblok/design-system'
2542
import '@storyblok/design-system/dist/storyblok-design-system.css'
26-
43+
2744
app.use(BlokInk) // vue 3
2845
```
2946

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

4057
You can also only install a few components, by specifying the option `withComponents`.
58+
4159
```js
4260
import BlokInk from '@storyblok/design-system'
4361
import '@storyblok/design-system/dist/storyblok-design-system.css'
44-
62+
4563
app.use(BlokInk, {
46-
withComponents: [
47-
'SbButton',
48-
'SbIcon',
49-
]
64+
withComponents: ['SbButton', 'SbIcon'],
5065
})
5166
```
5267

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

5771
## Development
5872

5973
To develop within the Design System you can use Storybook that has all components setup:
74+
6075
### Start & Execute Storybook
76+
6177
```sh
6278
yarn # or npm install
6379
yarn storybook
6480
```
6581

6682
### Compiles and minifies for production
83+
6784
```sh
6885
yarn build
6986
```
7087

7188
### Run your unit tests
89+
7290
```sh
7391
yarn test:unit
7492
```
7593

7694
### Lints and fixes files
95+
7796
```sh
7897
yarn lint
7998
```
8099

81-
82100
---
83101

84102
<p align="center">

0 commit comments

Comments
 (0)