Skip to content

Commit ae7c430

Browse files
Update readme
1 parent df232ae commit ae7c430

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ Once installed, our GPC Privacy Choice Extension injects a privacy choice scheme
2424
GPC Privacy Choice is developed and maintained by **Eliza Kuller (@ekuller)**, **Chunyue Ma (@chunyuema)**, **Isabella Tassone (@bella-tassone)**, **Joe Champeau (@JoeChampeau)**, and **Sebastian Zimmeck (@SebastianZimmeck)** of the [privacy-tech-lab](https://privacytechlab.org/). Kuba Alicki (@kalicki1), Daniel Knopf (@dknopf), and Abdallah Salia (@asalia-1) contributed earlier.
2525

2626
[1. Research Publications](#1-research-publications)
27-
[2. Quick DEV Set-Up Guide](#2-quick-dev-set-up-guide)
27+
[2. Quick Developer Set-Up Guide](#2-quick-developer-set-up-guide)
2828
[3. Privacy Choice Schemes](#3-privacy-choice-schemes)
2929
[4. Data Collection](#4-data-collection)
30-
[5. Full Developer's Guide to Implement GPC Privacy Choice](#5-full-developers-guide-to-implement-gpc-privacy-choice)
30+
[5. Full Developer Set-Up Guide to Implement GPC Privacy Choice](#5-full-developer-set-up-guide-to-implement-gpc-privacy-choice)
3131
[6. GPC Privacy Choice Architectural Overview](#6-gpc-privacy-choice-architectural-overview)
3232
[7. Files and Directories in this Repo](#7-files-and-directories-in-this-repo)
3333
[8. Third Party Libraries](#8-third-party-libraries)
@@ -43,11 +43,16 @@ GPC Privacy Choice is developed and maintained by **Eliza Kuller (@ekuller)**, *
4343
- Sebastian Zimmeck, [Improving Internet Privacy with Global Privacy Control (GPC)](https://sebastianzimmeck.de/SaTC_PI_Meeting_2022_Poster_GPC_Zimmeck.pdf), 5th NSF Secure and Trustworthy Cyberspace Principal Investigator Meeting (2022 SaTC PI Meeting), Arlington, Virginia, USA, June 2022
4444
- Eliza Kuller, Chunyue Ma, Isabella Tassone, Sebastian Zimmeck, [Making Online Privacy Choice Mechanisms Effective and Usable](http://summer21.research.wesleyan.edu/2021/07/22/balancing-usability-and-active-choice-while-developing-privacy-permission-schemes/), Summer Research 2021 Poster Session, Wesleyan University, Online, July 2021
4545

46-
## 2. Quick DEV Set-Up Guide
46+
## 2. Quick Developer Set-Up Guide
4747

4848
In order to set up the environment for our extension, you should have Git installed.
4949

50-
1. Clone this repo: `git clone https://github.com/privacy-tech-lab/gpc-privacy-choice.git`.
50+
1. Clone this repo:
51+
52+
```bash
53+
git clone https://github.com/privacy-tech-lab/gpc-privacy-choice.git
54+
```
55+
5156
2. In the `src` folder, create a `config.js` file. If you not wish to set up a Firebase backend and only want to observe the frontend UI, you can copy the following information into the required config file and use the provided password (12345).
5257

5358
```javascript
@@ -63,10 +68,10 @@ In order to set up the environment for our extension, you should have Git instal
6368
};
6469
```
6570

66-
Alternatively, if you wish to set up your own Firebase backend, we recommend looking at our [Full Developer's Guide to Implement GPC Privacy Choice](https://github.com/privacy-tech-lab/gpc-privacy-choice#5-full-developers-guide-to-implement-gpc-privacy-choice) for more in-depth instructions.
71+
Alternatively, if you wish to set up your own Firebase backend, we recommend looking at our [Full Developer Set-Up Guide to Implement GPC Privacy Choice](https://github.com/privacy-tech-lab/gpc-privacy-choice#5-full-developer-set-up-guide-to-implement-gpc-privacy-choice) for more in-depth instructions.
6772

6873
3. To test the extension from a local repo, open the browser (Chrome, Brave, etc) and find the manage extension options from settings.
69-
4. Turn on developer mode, and then click the `Load unpacked` button. Select the folder `gpc-privacy-choice/src` from your files.
74+
4. Turn on developer mode, and then click the `Load unpacked` button. Select the folder `gpc-privacy-choice/src`.
7075
5. The extension should now be loaded and you should see the registration page pop up on the browser. We signed up participants for our usability study to test the different schemes via [Prolific](https://www.prolific.com). In order to access the extension, supply a string formatted as a valid Prolific ID (you may use 5a123456xyz12u123v123456 for testing purposes). You also need to supply the password you created above. The registration process should start.
7176
6. You may switch between schemes by manually setting it in line 741 of the `background.js` file of the repository, where there is a list of what number corresponds to which scheme. See [Privacy Choice Schemes](https://github.com/privacy-tech-lab/gpc-privacy-choice#3-privacy-choice-schemes) for full descriptions of each scheme.
7277

@@ -256,7 +261,7 @@ The Mute Interaction History covers schemes where the **Snooze** button is prese
256261
<img width="600" alt="Mute Interaction History screenshot." src="https://user-images.githubusercontent.com/54873610/169371757-e957143b-e7a2-4973-9bf4-e11c87e825d7.png">
257262
</p>
258263

259-
## 5. Full Developer's Guide to Implement GPC Privacy Choice
264+
## 5. Full Developer Set-Up Guide to Implement GPC Privacy Choice
260265

261266
**NOTE: In order to create a Firebase project, you need 'Cloud Resource Manager project creation' to be enabled. This may be disabled if you are using an institutional account.**
262267

0 commit comments

Comments
 (0)