build: copy readmes to dist folder on build

README.md

@@ -5,10 +5,10 @@ SVG gauge component for Angular
 <table>
   <tr>
     <td>
-      <img src="./assets/gauge.png" alt="ng2-gauge" />
+      <img src="https://raw.githubusercontent.com/hawkgs/ng2-gauge/master/assets/gauge.png" alt="ng2-gauge" />
     </td>
     <td>
-      <img src="./assets/demo.gif" />
+      <img src="https://raw.githubusercontent.com/hawkgs/ng2-gauge/master/assets/demo.gif" />
       <p><em>Suitable for building virtual dashboards (initially designed for that).</em></p>
     </td>
   </tr>

package.json

@@ -21,7 +21,7 @@
   "scripts": {
     "ng": "ng",
     "start": "ng serve demo-app",
-    "build": "ng build ng2-gauge",
+    "build": "ng build ng2-gauge && ts-node ./scripts/copy-readme.ts",
     "watch:ng2-gauge": "ng build ng2-gauge --watch",
     "test": "ng test",
     "lint": "ng lint ng2-gauge"
@@ -57,6 +57,7 @@
     "karma-jasmine": "~5.1.0",
     "karma-jasmine-html-reporter": "~2.1.0",
     "ng-packagr": "^17.1.2",
+    "ts-node": "^10.9.2",
     "typescript": "~5.2.2"
   }
 }

projects/ng2-gauge/ng-package.json

@@ -4,4 +4,4 @@
   "lib": {
     "entryFile": "src/public_api.ts"
   }
-}
+}

scripts/copy-readme.ts

@@ -0,0 +1,17 @@
+const fs = require('fs');
+
+const copyFileToBuildRoot = (src: string) => {
+  const fileName = src.split('/').pop();
+  fs.copyFile(src, `./dist/ng2-gauge/${fileName}`, (err: unknown) => {
+    if (err) {
+      throw new Error(`Unable to copy ${fileName}`);
+    }
+  });
+};
+
+console.log('Copying additional files to the dist folder ...');
+
+copyFileToBuildRoot('./README.md');
+copyFileToBuildRoot('./CHANGELOG.md');
+
+console.log('Done!');