Skip to content

Commit

Permalink
Description improvements (#17)
Browse files Browse the repository at this point in the history
* Description improvements

* Fix linter
  • Loading branch information
dedoussis authored Dec 29, 2022
1 parent 7f281d3 commit 8e414da
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Tests Status](https://github.com/dedoussis/icloud-hide-my-email-browser-extension/workflows/tests/badge.svg)](https://github.com/dedoussis/icloud-hide-my-email-browser-extension/actions/workflows/tests.yml)

[Hide My Email](https://support.apple.com/en-us/HT210425) is a premium feature of iCloud that is natively supported in Safari. This extension aims to bring a similar UX to a wider variety of browsers. In particular, it has been explicitly tested to work on:
[Hide My Email](https://support.apple.com/en-us/HT210425) is a premium privacy service of iCloud. Safari offers a native integration with Hide My Email, whereby users are prompted to generate a Hide My Email address upon registration to any website. This extension aims to bring a similar UX into a wider variety of browsers. In particular, it has been explicitly tested to work on:

- [Chrome](https://chrome.google.com/webstore/detail/icloud-hide-my-email/omiaekblhgfopjkjnenhahfgcgnbohlk)
- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/icloud-hide-my-email/)
Expand Down Expand Up @@ -72,7 +72,7 @@ ENTRYPOINT ["sh"]

### Developer workflow

The following table outlines the sequence of steps that need to be followed in order to ship a change in the extension. The execution of some of these steps varies per browser/manifest version.
The table below outlines the sequence of steps that need to be followed in order to ship a change in the extension. The execution of some of these steps varies per browser/manifest version.

Note: the following console commands are to be executed from the root directory of this repo

Expand All @@ -94,5 +94,5 @@ Note: the following console commands are to be executed from the root directory
- [ ] Ability to modify the label and note of existing HME addresses
- [ ] Options page to validate client token
- [ ] Expiration of session data stored in Chrome storage
- [ ] CI/CD
- [ ] CI and maybe CD
- [ ] Dependabot
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "icloud-hide-my-email-browser-extension",
"version": "1.0.4",
"description": "Browser extension enabling iCloud's Hide My Email feature.",
"description": "Cross-browser extension enabling the usage of iCloud's Hide My Email service.",
"license": "MIT",
"author": "dedoussis",
"repository": {
Expand Down
5 changes: 2 additions & 3 deletions src/iCloudClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,8 @@ export const EMPTY_SESSION_DATA = {
export class ICloudClientSession {
constructor(
public data: ICloudClientSessionData = EMPTY_SESSION_DATA,
private readonly dataSaver: (data: ICloudClientSessionData) => void = (
_data
) => undefined
private readonly dataSaver: (data: ICloudClientSessionData) => void = () =>
undefined
) {}

async save(): Promise<void> {
Expand Down
2 changes: 1 addition & 1 deletion src/manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "iCloud Hide My Email",
"description": "Browser extension enabling iCloud's Hide My Email feature.",
"description": "Use iCloud's Hide My Email service on Chrome.",
"manifest_version": 3,
"background": { "service_worker": "background.bundle.js" },
"action": {
Expand Down
2 changes: 2 additions & 0 deletions webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ const makeManifestV2 = (mv3) => {
'host_permissions',
'options_page',
'declarative_net_request',
'description',
];
const commonKeys = Object.keys(mv3).filter(
(k) => !transformedV3Keys.includes(k)
Expand All @@ -44,6 +45,7 @@ const makeManifestV2 = (mv3) => {
return {
...innerJoin,
manifest_version: 2,
description: "Use iCloud's Hide My Email service on Firefox.",
background: { scripts: [mv3.background.service_worker] },
browser_action: mv3.action,
browser_specific_settings: {
Expand Down

0 comments on commit 8e414da

Please sign in to comment.