@swisspost/design-system-styles 5.0.0-beta.4 → 5.1.0

package/README.md

@@ -1,10 +1,15 @@
+# Design System Styles
+
 ![Swiss Post Design System splash screen](https://user-images.githubusercontent.com/1659006/187683368-d3aa2534-84be-4580-846e-2cad3796b573.png)
 
-# Design System Styles
+Styles for the Swiss Post web platform.
+
+## Documentation
 
-Common styles for the Swiss Post web platform.
+- Technical docs: [Swiss Post Design System](https://design-system.post.ch)
+- Design docs: [Experience Hub](https://www.experience-hub.ch/document/2803)
 
-## Usage
+## Installation
 
 <br>
 <details>
@@ -12,51 +17,52 @@ Common styles for the Swiss Post web platform.
   
   In order to be able to use `npm` commands, [node.js](https://nodejs.org/en/) needs to be installed on your machine.
 
-  The `scss` files in our styling package make use of the latest features of Sass. If you are planning to compile the .scss files in your project, be sure to use an up to date version of the latest Sass implementation ([dart-sass](https://sass-lang.com/dart-sass), `npm i sass@latest`). LibSass or Ruby Sass are not supported. If you can not meet this prerequisite, you can still use the precompiled CSS files included in the styling package.
+The `scss` files in our styling package make use of the latest features of Sass. If you are planning to compile the .scss files in your project, be sure to use an up to date version of the latest Sass implementation ([dart-sass](https://sass-lang.com/dart-sass), `npm i sass@latest`). LibSass or Ruby Sass are not supported. If you can not meet this prerequisite, you can still use the precompiled CSS files included in the styling package.
+
 </details>
 <br>
 
 Install the styling package
+
 ```bash
   npm install @swisspost/design-system-styles
 ```
 
 Import the stylesheet into your project, e.g. `src/styles.scss`.
+
 ```scss
-@use "node_modules/@swisspost/design-system-styles/<bundle-name>.scss
+@use "@swisspost/design-system-styles/<bundle-name>.scss";
 ```
 
-Available bundles:
-- index.scss (internet facing applications)
-- intranet.scss (internal applications)
-- basics.scss (atomic styles for font, buttons, lists etc.)
-- core.scss (variables, mixins, functions and placeholders only)
+Available Sass entrypoints:
 
-## Migrations Schematics
+- **index.scss** (internet facing applications)
+- **intranet.scss** (internal applications)
+- **basics.scss** (atomic styles for font, buttons, lists etc.)
+- **core.scss** (variables, mixins, functions and placeholders only)
 
-Schematics are used to transform an Angular software project by adapting it to current Design System Styles.
+Available CSS bundles:
 
-### Testing
+- **index.css** (internet facing applications)
+- **intranet.css** (internal applications)
+- **basics.css** (atomic styles for font, buttons, lists etc.)
 
-To test the Schematics without writing any changes to your files, install `@angular-devkit/schematics-cli` globally and use the `schematics` command line tool.<br>
-That tool acts the same as the `generate` command of the Angular CLI, but also has a debug mode.
+## Migration guide
 
-Run the following command in the project which uses this package as dependency:
+To execute the migrations please follow our [migration guide](https://design-system.post.ch/).
 
-```bash
-schematics ./node_modules/@swisspost/design-system-styles:migration-name
-```
+## Contribute
 
-Replace `migration-name` with any defined migration in the migrations.json file or simply get some help with:
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
-```bash
-schematics --help
-```
+Considering supporting the Swiss Post Design System with your contribution? Whether you like to contribute new patterns, fix a bug, spotted a typo or have ideas for improvement - we'd love to hear from you. Learn how you can contribute to this project in the [styles contribution guidelines](./CONTRIBUTING.md) and also take a look at the [general contribution guidelines](../../CONTRIBUTING.md).
 
-### Migrate
+For any questions regarding the pattern library, you can reach out on the [discussions page](https://github.com/swisspost/design-system/discussions).
 
-To execute the migrations please follow our [migration guide](https://design-system.post.ch/).
+In order to keep our community open and inclusive, we expect you to read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md).
+
+## License
 
-## Contributing
+Software contained in this repository is published by the Swiss Post Ltd. under the [Apache 2.0 License](./LICENSE).
 
-Learn how you can contribute to this project in the [contribution guidelines](./CONTRIBUTING.md).
+© 2022 Swiss Post, Ltd.