Skip to content

Commit

Permalink
Prepare for release 1.4.1 (#62)
Browse files Browse the repository at this point in the history
* Rename Chrome OS to ChromeOS

* Prepare for release 1.4.1

---------

Co-authored-by: Byron Lee <[email protected]>
  • Loading branch information
BaiiYuan and Byron Lee authored Jan 9, 2025
1 parent 8a918cf commit 2354bd5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Telemetry Support Library for Chrome OS
# Telemetry Support Library for ChromeOS

This repository contains a library code that facilitates access to the telemetry
and diagnostics APIs on Chrome OS.
and diagnostics APIs on ChromeOS.

The code in this repository contains most of the code from
[dpsl](https://source.chromium.org/chromium/chromium/src/+/main:ash/webui/telemetry_extension_ui/resources/dpsl/)
and is tweaked to integrate with the Chrome OS system extension APIs.
and is tweaked to integrate with the ChromeOS system extension APIs.

# Usages
## Usages

The library is published via npm and can be included by importing code.
The importing code represents a special type of chrome extensions
Expand All @@ -22,7 +22,7 @@ Publishing status: published in [npm](https://www.npmjs.com/package/cros-dpsl-js

1. `npm install cros-dpsl-js`
2. Import the package in your source code: `import { dpsl } from 'cros-dpsl-js';`
3. Begin using the library through the dpsl.* namespace.
3. Begin using the library through the dpsl.\* namespace.
4. See the currently supported APIs and sample usages in [src/README.md](https://github.com/GoogleChromeLabs/telemetry-support-extension-for-chromeos/blob/main/src/README.md).

Currently, the library is integrated in another project. Refer to usages to know more: [cros-sample-telemetry-extension](https://github.com/GoogleChromeLabs/cros-sample-telemetry-extension).
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "cros-dpsl-js",
"version": "1.4.0",
"description": "Diagnostics processor support library for Chrome OS",
"version": "1.4.1",
"description": "Diagnostics processor support library for ChromeOS",
"main": "./src/dpsl.js",
"exports": "./src/dpsl.js",
"directories": {
Expand Down
2 changes: 1 addition & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ class Routine {
#### Important Notes regarding routine's id
- The code (chrome browser extension) that uses the library needs to remember the routine's id so that it can perform operations on it (i.e. Routine.getStatus()) after the service worker is restarted.

- Chrome OS doesn't persist routines across reboots. This means that depending code must not rely on routines created in previous sessions.
- ChromeOS doesn't persist routines across reboots. This means that depending code must not rely on routines created in previous sessions.

- Routine's id usually starts with 0.

Expand Down

0 comments on commit 2354bd5

Please sign in to comment.