@amsterdam/design-system-assets 0.2.1 → 0.2.2

package/CHANGELOG.md

@@ -3,8 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [0.2.1](https://github.com/Amsterdam/design-system/compare/design-system-assets-v0.2.0...design-system-assets-v0.2.1) (2024-06-05)
+## [0.2.2](https://github.com/Amsterdam/design-system/compare/design-system-assets-v0.2.1...design-system-assets-v0.2.2) (2024-10-25)
+
+### Features
 
+* Use inline SVG icon for Radio button ([#1460](https://github.com/Amsterdam/design-system/issues/1460)) ([c19055b](https://github.com/Amsterdam/design-system/commit/c19055bd6453ce40ca43b31d599f14ec65d6037a))
+
+## [0.2.1](https://github.com/Amsterdam/design-system/compare/design-system-assets-v0.2.0...design-system-assets-v0.2.1) (2024-06-05)
 
 ### Features
 
@@ -12,7 +17,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ## [0.2.0](https://github.com/Amsterdam/design-system/compare/design-system-assets-v0.1.8...design-system-assets-v0.2.0) (2024-03-12)
 
-
 ### ⚠ BREAKING CHANGES
 
 * Shorten namespaces in theme and tokens ([#1125](https://github.com/Amsterdam/design-system/issues/1125))
@@ -23,7 +27,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ## [0.1.8](https://github.com/Amsterdam/design-system/compare/design-system-assets-v0.1.7...design-system-assets-v0.1.8) (2024-03-08)
 
-
 ### Features
 
 * Logo Museum Weesp  ([#1088](https://github.com/Amsterdam/design-system/issues/1088)) ([da1b780](https://github.com/Amsterdam/design-system/commit/da1b7808b5bcf17acb93fe46531a9722814e9256))

package/README.md

@@ -1,9 +1,63 @@
 <!-- @license CC0-1.0 -->
 
-# Assets
+# Amsterdam Design System: Assets
 
-Assets for the City of Amsterdam
+This package provides all assets from the [Amsterdam Design System](https://designsystem.amsterdam).
+Use it to include the correct fonts, icons or logos in your website or application.
 
-## Web app manifest, app icons and favicon
+## Installation
 
-See the Design System documentation for an [overview and examples of the manifest and these icons](https://amsterdam.github.io/design-system/?path=/docs/docs-assets-favicon-app-icons--docs).
+Install this package by itself if you want or need to reference assets directly in your project.
+
+Note that our [React components](https://www.npmjs.com/package/@amsterdam/design-system-react) provide more functionality for some of the assets and use them automatically.
+You should use that package if your application uses React.
+
+```sh
+npm install @amsterdam/design-system-assets
+```
+
+## Usage
+
+### Application icons
+
+The Design System handbook helps using [a favicon](https://designsystem.amsterdam/?path=/docs/brand-assets-favicon--docs) or [a web manifest and application icons](https://designsystem.amsterdam/?path=/docs/docs-developer-guide-web-app--docs) for home screens of devices in your website or application.
+
+### Font files
+
+The package contains our Amsterdam Sans font in OpenType format (.otf) and Web Open Format Font (.woff).
+Import our stylesheet to make all of them available to your project.
+
+<!-- prettier-ignore -->
+```ts
+import "@amsterdam/design-system-assets/font/index.css"
+```
+
+The Design System Handbook offers [more guidance in using the font](https://designsystem.amsterdam/?path=/docs/brand-assets-font--docs).
+
+Note that the font is proprietary. Using it requires [a license](https://designsystem.amsterdam/?path=/docs/docs-terms-of-use-copyright--docs).
+
+### Icons
+
+The Design System Handbook offers an [overview of our icon library](https://designsystem.amsterdam/?path=/docs/brand-assets-icons--docs).
+
+You can import the SVG files to use icons in your website or application.
+
+In a React project, use the [Icon component](https://designsystem.amsterdam/?path=/docs/components-media-icon--docs) instead.
+It offers a convenient API for using the icons and streamlines alignment with text.
+
+### Logos
+
+The logo of the City of Amsterdam is available as an SVG image, as well as logos for various departments and services.
+
+In a React project, use the [Logo component](https://designsystem.amsterdam/?path=/docs/components-media-logo--docs) instead.
+
+## Updating
+
+We follow semantic versioning and publish a [change log](https://github.com/Amsterdam/design-system/blob/main/proprietary/assets/CHANGELOG.md) to guide you through updates.
+The assets are a public API of the design system.
+Note that detecting changed or deleted assets is still a manual process.
+
+## Support
+
+Contact us if you have a question, find an issue, or want to contribute.
+Find ways to reach us on [designsystem.amsterdam](https://designsystem.amsterdam/?path=/docs/docs-introduction--docs#send-a-message).

package/icons/Radio.svg

@@ -0,0 +1 @@
+<svg viewBox='0 0 32 32' xmlns='http://www.w3.org/2000/svg'><circle class="ams-radio__circle" r='14' cx='16' cy='16' /><circle class="ams-radio__checked-indicator" r='10' cx='16' cy='16' /></svg>

package/package.json

@@ -1,10 +1,15 @@
 {
-  "version": "0.2.1",
-  "author": "Community for NL Design System",
-  "description": "Assets for the City of Amsterdam",
+  "version": "0.2.2",
+  "author": "Design System Team, City of Amsterdam <designsystem@amsterdam.nl>",
+  "description": "All assets from the Amsterdam Design System. Use it to include the correct fonts, icons or logos in your website or application.",
+  "homepage": "https://designsystem.amsterdam/",
   "license": "SEE LICENSE IN LICENSE.md",
   "name": "@amsterdam/design-system-assets",
   "keywords": [
+    "amsterdam",
+    "amsterdam-design-system",
+    "assets",
+    "design-system",
     "nl-design-system"
   ],
   "private": false,