Skip to content

Commit

Permalink
Edit README and PRIVACY_POLICY files
Browse files Browse the repository at this point in the history
  • Loading branch information
3BenLee committed Nov 20, 2020
1 parent b9931c8 commit 24fc02e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
8 changes: 4 additions & 4 deletions PRIVACY_POLICY.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Information We Collect

Does your web extension collect data?

- I collect this
- I don't collect that
- I collect data
- I don't collect data

How it uses your cookies
How it uses cookies
========================

If your web extension uses cookie. Describe where does your extension use cookie? and Why?
If your web extension uses cookies, describe where your extension uses cookies and why?
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<br />
</div>

The boilerplate provides the skeleton to start developing cross-browser web extension.
This boilerplate provides a skeleton to start developing cross-browser web extensions.

[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/davidnguyen179/web-extension-boilerplate/pulls)
![ci/cd](https://github.com/davidnguyen179/web-extension-boilerplate/workflows/ci/cd/badge.svg)
Expand Down Expand Up @@ -63,7 +63,7 @@ npm run firefox

**Chrome**

1. On the browser's URL address bar
1. Go to the browser's URL address bar
2. Enter `chrome://extensions/`
3. Switch to "**Developer mode**"
4. Load extension by clicking "**Load unpacked**"
Expand All @@ -74,7 +74,7 @@ Check here for more detail: [https://developer.chrome.com/extensions/getstarted]

**Edge**

1. On the browser's URL address bar
1. Go to the browser's URL address bar
2. Enter `edge://extensions/`
3. Turn on `Developer mode`
4. Load extension by clicking "**Load unpacked**"
Expand All @@ -83,31 +83,31 @@ Check here for more detail: [https://developer.chrome.com/extensions/getstarted]

**Firefox**

1. On the browser's URL address bar
1. Go to the browser's URL address bar
2. Enter `about:debugging#/runtime/this-firefox`
3. Click **Load Temporary Add-on...**
4. Browser to your `manifest.json` & click **Open**
4. Browse to your `manifest.json` & click **Open**
5. Done!

Check here for more detail: [https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/)
Check here for more details: [https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/)

## Privacy Policy file

Web stores require you to describe what the extension is or if you collect data of users, you also need to describe why you do that.
Web stores require you to describe what the extension is or if you collect data of users. You also need to describe why you do that.

Make sure you have this file, when you publish an extension, the web store may ask you to upload it.
Make sure you include this file when you publish an extension, the web store may ask you to upload it.

**Note:** If you don't know how to write it, you can look at the [existing one](https://github.com/davidnguyen179/web-extension-boilerplate/blob/main/PRIVACY_POLICY.txt) attached on this repository.
**Note:** If you don't know how to write a privacy policy file, you can look at the [existing one](https://github.com/davidnguyen179/web-extension-boilerplate/blob/main/PRIVACY_POLICY.txt) attached on this repository.

## Badges

You can add badges to your project like: version, how many users of your extension here:
You can add badges to your project to indicate the version or to show how many users use your extension here:

- [https://shields.io/](https://shields.io/)

## CI/CD with github action

You can modify the `.github/workflows` to have expected CI/CD flow.
You can modify the `.github/workflows` to show the CI/CD flow.

- [https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-nodejs](https://docs.github.com/en/free-pro-team@latest/actions/guides/building-and-testing-nodejs)

Expand All @@ -123,9 +123,9 @@ You can modify the `.github/workflows` to have expected CI/CD flow.

- Develop your first Chrome extension & Chromium Edge: [https://developer.chrome.com/extensions](https://developer.chrome.com/extensions)
- Develop your first Firefox add-on: [https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension)
- If you have any issue related to chrome extension, you can post your issue here: [https://groups.google.com/a/chromium.org/forum/#!forum/chromium-extensions](https://groups.google.com/a/chromium.org/forum/#!forum/chromium-extensions)
- [Jack and Amy Dev youtube channel](https://www.youtube.com/channel/UCVj3dGw75v8aHFYD6CL1tFg), which explains some common mistakes when we develop Chrome extension.
- If you have any Chrome extension issues, you can post it here: [https://groups.google.com/a/chromium.org/forum/#!forum/chromium-extensions](https://groups.google.com/a/chromium.org/forum/#!forum/chromium-extensions)
- [Jack and Amy Dev youtube channel](https://www.youtube.com/channel/UCVj3dGw75v8aHFYD6CL1tFg), which explains some common mistakes made when developing Chrome extensions.

## Showcase

This boilerplate is used to develop [Spotify Web Extension](https://spotify-extension.netlify.app/)
This boilerplate was used to develop [Spotify Web Extension](https://spotify-extension.netlify.app/)

0 comments on commit 24fc02e

Please sign in to comment.