Skip to content

Commit 104f48b

Browse files
committed
updated README
1 parent bc7d415 commit 104f48b

File tree

3 files changed

+25
-16
lines changed

3 files changed

+25
-16
lines changed

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,10 @@ build/
77
.vscode
88
dist/
99
webpack.config.js
10+
11+
# for public repo
12+
detected.png
13+
loader-icon.png
14+
logo.png
15+
stripe-v3.js
16+
styles.css

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
1-
# TermTrimmer
1+
# DocDecoder Chrome Extension 📜
22

3-
Source code for TermTrimmer chrome extension.
3+
This repo contains all source code and assets included in the DocDecoder Chrome Extension.
44

5-
## Deployment Architecture
5+
## What is DocDecoder?
66

7-
- 2x EC2 Servers
8-
- At least 4x cores per server
9-
- 9 Gunicorn workers per server: (2 x num_cores) + 1
10-
- Load balance traffic between the 2 servers
11-
- Setup autoscaling rules to account for usage spikes(?)
7+
DocDecoder is a free (no account required) browser extension that summarises web policies with GPT-4.
128

13-
## Release Plan
9+
**Our aim is to solve one of the internet's oldest problems - nobody reads the poicies they bind themselves to online.**
1410

15-
Promote on Kickstarter and Indigogo first, offering free trial for supporters.
11+
![DocDecoder Extension Screenshot](https://cdn.shopify.com/s/files/1/0673/2005/4067/files/Capture_1.png?v=1701211750)
1612

17-
Release for $1/month on Chrome Web Store.
13+
This extension takes the URL of any web/legal policy and 'summarises' it in a way that explains *exactly* what the user is agreeing to, at a glance.
1814

19-
Offer free trial?
15+
Any potentiallly harmful/sinister terms are highlighted in red.
2016

21-
### Notes
17+
## Project Links
2218

23-
Need to make logo and sort branding.
19+
[Download (Chromium)](https://chromewebstore.google.com/u/8/detail/docdecoder-ai-powered-pol/pbcajhinmaijadgdofjohponnggbkjhh?hl=en)
20+
21+
[Website](https://docdecoder.app)
22+
23+
## Contact
24+
25+
For all enquiries, please email [email protected].

manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"manifest_version": 3,
3-
"name": "DocDecoder - AI-Powered Policy Summariser",
3+
"name": "DocDecoder - Summarize Web Policies With AI",
44
"description": "DocDecoder uses GPT-4 to generate clear, concise summaries of any site's legal policies for you to skim over before you accept them.",
5-
"version": "1.1.3",
5+
"version": "1.1.4",
66
"action": {
77
"default_popup": "popup.html",
88
"default_icon": {

0 commit comments

Comments
 (0)