make repo publish ready (#7)

Signed-off-by: Kangrui Ye <[email protected]>

README.md

@@ -0,0 +1,46 @@
+# Cloudflight Style Dictionary
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
+![master](https://github.com/cloudflightio/cloudflight-style-dictionary-transformer/actions/workflows/build.yml/badge.svg?branch=master)
+[![@cloudflight/style-dictionary-transformer](https://img.shields.io/npm/v/@cloudflight/style-dictionary-transformer?label=@cloudflight/style-dictionary-transformer)](https://www.npmjs.com/package/@cloudflight/style-dictionary-transformer)
+
+Amazon style dictionary configured with Cloudflight best practices in mind.
+
+## Installation
+
+The following dependencies are required:
+
+```
+"style-dictionary": "*"
+```
+
+## Usage
+
+Create a javascript file with the following content:
+
+```javascript
+import {
+    cloudflightPlatformConfigWith,
+    registerItems,
+} from '@cloudflight/style-dictionary-transformer';
+import StyleDictionary from 'style-dictionary';
+
+registerItems(StyleDictionary);
+
+const StyleDictionaryExtended = StyleDictionary.extend({
+    source: ['assets/design-tokens/*.json'],
+    platforms: {
+        ...cloudflightPlatformConfigWith({
+            styleDeclarationOutputDirectory: '<your-output-directory>',
+        }),
+    },
+});
+
+StyleDictionaryExtended.buildAllPlatforms();
+```
+
+Execute this script as part of your build. It will generate styles into you output directory for further use.
+
+## Contributing
+
+-   [Contributing to the project](CONTRIBUTING.md)

package.json

@@ -5,6 +5,14 @@
     "main": "./dist/index.js",
     "author": "Cloudflight GmbH",
     "license": "Apache-2.0",
+    "keywords": [
+        "style-dictionary",
+        "transform"
+    ],
+    "homepage": "https://github.com/cloudflightio/style-dictionary-transformer",
+    "bugs": {
+        "url": "https://github.com/cloudflightio/style-dictionary-transformer/issues"
+    },
     "publishConfig": {
         "access": "public"
     },

src/transform-groups/custom-properties.ts

@@ -11,7 +11,7 @@ export const customPropertiesTransformGroup: Named<TransformGroup> = {
         'name/cti/kebab',
         'time/seconds',
         'content/icon',
-        'color/hsl-4',
+        'color/hex',
         pxTransform.name,
         percentTransform.name,
         fontStyleTransform.name,

test-data/color-transform/expected/variables_impl.css

@@ -1,4 +1,4 @@
 :root {
-    --color-my-super-fancy-red: hsl(0 100% 50%);
-    --color-my-super-fancy-green: hsl(118 44% 33%);
+    --color-my-super-fancy-red: #ff0000;
+    --color-my-super-fancy-green: #327a30;
 }