Merge pull request #1 from wridgeu/fix/feat-add-yaml

fix: add ui5.yaml to npm package content

Author: mariokernich

README.md

@@ -43,12 +43,20 @@ Add the `fontawesome.icons.lib` library dependency to your `manifest.json` and f
 }
 ```
 
-### Method 1: Using NPM Package with UI5 middleware (Recommended) 
+### Method 1: Using NPM Package (Recommended)
 
 Install Dependencies
 
 ```bash
-npm install ui5-fontawesome-lib ui5-middleware-servestatic --save-dev
+npm i ui5-fontawesome-lib
+```
+
+That should be it. The UI5 tooling will recognize the UI5 dependency (verifiable via UI5 CLI command `UI5 tree`) and take care of loading it for you.
+
+#### with UI5 middleware (alternative recommendation)
+
+```bash
+npm i ui5-fontawesome-lib && npm i -D ui5-middleware-servestatic
 ```
 
 Add the following configuration to your `ui5.yaml`:

package.json

@@ -23,7 +23,8 @@
     "dist/**/*",
     "src/**/*",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "ui5.yaml"
   ],
   "scripts": {
     "build": "npm run build:icons && ui5 build --clean-dest",

ui5.yaml

@@ -1,4 +1,4 @@
-specVersion: "1.0"
+specVersion: "4.0"
 metadata:
   name: fontawesome.icons.lib
 type: library