Skip to content

Commit

Permalink
Updated README and cleaned up deps
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianfish committed Mar 22, 2024
1 parent 2167e0f commit 44114fe
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 26 deletions.
6 changes: 2 additions & 4 deletions webcomponents/tool/src/main/frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# sakai-push-utils

A set of utility functions for handling translations in Sakai. It converts
java properties file formats into js objects.
A set of utility functions for setting up browser push in Sakai.

## Installation

Expand All @@ -12,9 +11,9 @@ npm i @sakai-ui/sakai-push-utils
## Usage

```html
import { setup } from "@sakai-ui/sakai-push-utils";
import { pushSetupComplete } from "@sakai-ui/sakai-push-utils";

setup.then(() => console.log("push setup complete"));
pushSetupComplete.then(() => console.log("push setup complete"));

```

Expand All @@ -23,25 +22,13 @@ setup.then(() => console.log("push setup complete"));
To scan the project for linting and formatting errors, run

```bash
npm run lint
```

To automatically fix linting and formatting errors, run

```bash
npm run format
npm run lint:fix
```

## Testing with Web Test Runner

To execute a single test run:
To execute the tests for this module, run

```bash
npm run test
```

To run the tests in interactive watch mode run:

```bash
npm run test:watch
```
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,10 @@
"devDependencies": {
"@open-wc/testing": "^4.0.0",
"@web/test-runner": "^0.18.0",
"eslint": "^8.53.0",
"fetch-mock": "^9.11.0"
"eslint": "^8.53.0"
},
"dependencies": {
"@sakai-ui/sakai-portal-utils": "file:../sakai-portal-utils",
"get-browser-fingerprint": "^3.2.0",
"lit": "^3.1.0"
"get-browser-fingerprint": "^3.2.0"
}
}

0 comments on commit 44114fe

Please sign in to comment.