Skip to content

Commit

Permalink
docs: update README with packages from cdn
Browse files Browse the repository at this point in the history
  • Loading branch information
Robbert committed Jul 22, 2021
1 parent 06b1189 commit 313ec4d
Showing 1 changed file with 56 additions and 8 deletions.
64 changes: 56 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,63 @@
# Template
# Utrecht Design System

This design system is based on the architecture of the NL Design System POC
For more info about that architecture or the progress of the POC, join the `#nl-design-system-developers` Slack via [codefor.nl](https://codefor.nl)!
**This project is very much WORK IN PROGRESS and all components are released as _alpha_ version. Always define the exact version you want to use, and test for breaking changes before upgrading to a newer alpha release.**

## About this template
Applying design elements from this project is strictly prohibited for organisations that are not part of the Municipality of Utrecht.

This template contains all relevant linting rules used by the NL Design System repository.
It also contains the Storybook setup with two example components and two example general documentation page.
Feel free to add or modify those documentation pages and use the example components as an initial template to create your own storybook components.
This project is part of a community iniative to use NL Design System components for projects that need to adhere to the Utrecht Design System. Teams from the central Municipality of Utrecht, as well as those who are contracted by them to develop websites and apps, are able to collaborate via this project.

## Storybook
## Getting started

Include the Design Token CSS variables:

```html
<link
rel="stylesheet"
type="text/css"
href="https://unpkg.com/@nl-design-system-unstable/utrecht-design-tokens/dist/index.css"
/>
```

Combine it with the latest Web Components from the NL Design System community, for example:

```html
<script
src="https://unpkg.com/@utrecht/web-component-library-stencil/dist/utrecht/utrecht.esm.js"
type="module"
></script>
```

Then you can go ahead and see the result:

```html
<utrecht-html-content>
<h1>Page styled with NL Design System</h1>
</utrecht-html-content>
```

### Avoid automatic upgrades to a new version with breaking changes

For all dependencies, see what the version is you use while developing and update the URL without version to include a version number, and ensure your page keeps working even when new versions are released:

For _alpha_, _beta_ and _rc_ versions:

```text
https://unpkg.com/@nl-design-system-unstable/utrecht-design-tokens/dist/index.css
```

Above should become:

```text
https://unpkg.com/@nl-design-system-unstable/utrecht-design-tokens@1.0.0-alpha.37/dist/index.css
```

For stable versions it would become:

```text
https://unpkg.com/@nl-design-system-unstable/utrecht-design-tokens@^1.0.0/dist/index.css
```

## Contributing

### Run Storybook on your computer

Expand Down

0 comments on commit 313ec4d

Please sign in to comment.