Skip to content

Commit 3c91f3a

Browse files
author
ntwigg
committed
Separate static site is not necessary.
1 parent 5449591 commit 3c91f3a

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,14 @@ Thanks for your interest in contributing!
66

77
By submitting a Pull Request, you agree that your contributions are licensed under the same license as this project (Apache 2.0) and that you have the rights necessary to make this contribution.
88

9-
## Project layout
9+
## Privacy & security
1010

11-
- `browser-extension` primary project
12-
- `docs` static site deployed to [gitcasso.com](https://gitcasso.com)
11+
This extension ***must never transmit any data outside the browser***.
12+
13+
- it adds syntax highlighting by running local scripts
14+
- it stores unfinished comments in local storage
15+
- there is no need to initiate an outbound network request, no features will be added which require outbound network requests
16+
17+
## How to
18+
19+
- `browser-extension` is the primary project. Go to [its README.md](browser-extension/README.md) for development info.

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
# Gitcasso
1+
# <img align="left" src="browser-extension/public/icons/icon-48.png"> Gitcasso
22

3-
Browser extension which adds syntax highlighting to the `Write` view when you're commenting on issues and pull requests in GitHub, GitLab, and more!
3+
*Syntax highlighting and autosave for comments on GitHub (and other other markdown-friendly places).*
4+
5+
- "Syntax highlighting is the lie that enables us to see the truth."
6+
- "The meaning of life is to find your lost comment drafts. The purpose of life is to post them."
7+
8+
TODO: screenshot of GitHub comment syntax highlighting
9+
10+
TODO: screenshot of comment draft storage and restoration
411

512
If there's something you'd like to add or fix, see [CONTRIBUTING.md](CONTRIBUTING.md).

docs/TODO

Whitespace-only changes.

0 commit comments

Comments
 (0)