diff --git a/README.md b/README.md index 69daf3732..923cf07be 100755 --- a/README.md +++ b/README.md @@ -68,3 +68,11 @@ To build binary font files from .vfb sources you need [FontLab Studio 5](https:/ From FontLab, run `IBM Plex export FDK files.py` and choose a directory with IBM Plex .vfb source files. The script will create a new directory called `fdk` in which subdirectories are created for every font. The script will export files necessary for AFDKO in those subdirectories. Subsequently, OpenType Fonts (OTFs) or TrueType Fonts (TTFs) can be generated from the command line using `makeotf`, which is part of the AFDKO toolset. Information and usage instructions can be found by executing `makeotf -h`. + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency +you are agreeing to telemetry collection. To opt out, see +[opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection). +For more information on the data being collected, please see the +[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics). diff --git a/package.json b/package.json index 11226fe39..5ec6297f3 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,8 @@ "!IBM-Plex-Sans-KR/fonts/hinted/**/woff2", "!IBM-Plex-Sans-KR/fonts/hinted/**/woff", "!IBM-Plex-Sans-JP/fonts/hinted/**/woff2", - "!IBM-Plex-Sans-JP/fonts/hinted/**/woff" + "!IBM-Plex-Sans-JP/fonts/hinted/**/woff", + "telemetry.yml" ], "scripts": { "clean": "rimraf css scss deploy-preview", @@ -30,6 +31,7 @@ "build:scss": "node ./scripts/generate-scss.js", "build:deploy-preview": "gulp build:deploy-preview", "test": "parcel serve ./deploy-preview/index.html", + "postinstall": "ibmtelemetry --config=telemetry.yml", "precommit": "lint-staged", "prettier": "prettier --write \"**/*.{scss}\"", "prepare": "husky install && yarn build", @@ -86,5 +88,8 @@ "name": "ibm-plex", "sassDir": "scss", "needs": "*" + }, + "dependencies": { + "@ibm/telemetry-js": "^1.3.0" } } diff --git a/telemetry.yml b/telemetry.yml new file mode 100644 index 000000000..e23bc337e --- /dev/null +++ b/telemetry.yml @@ -0,0 +1,8 @@ +# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json + +version: 1 +projectId: bec7aecb-9d5a-4b18-8528-7762bd6232a3 +endpoint: https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics +collect: + npm: + dependencies: null diff --git a/yarn.lock b/yarn.lock index f9ef2950b..225de279f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -246,6 +246,11 @@ resolved "https://registry.yarnpkg.com/@iarna/toml/-/toml-2.2.5.tgz#b32366c89b43c6f8cefbdefac778b9c828e3ba8c" integrity sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg== +"@ibm/telemetry-js@^1.3.0": + version "1.3.0" + resolved "https://registry.yarnpkg.com/@ibm/telemetry-js/-/telemetry-js-1.3.0.tgz#321f2ed4bbbc78d69dc1ee9cb6f83d2d2af9baef" + integrity sha512-9gIkyF2B9RizWN6rsdQN76DN6D+/Xbr4HGTwm6EUujfXvEVtWbf4jzxDFwKvZkeTC2tjHpkUNJQKdivbMKt8yg== + "@jridgewell/gen-mapping@^0.3.0": version "0.3.3" resolved "https://registry.yarnpkg.com/@jridgewell/gen-mapping/-/gen-mapping-0.3.3.tgz#7e02e6eb5df901aaedb08514203b096614024098"