Skip to content

Commit

Permalink
docs: screenshots and instances
Browse files Browse the repository at this point in the history
  • Loading branch information
httpjamesm committed Dec 10, 2023
1 parent 0607ea7 commit 9539479
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/.svelte-kit
/node_modules
/docs
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Welcome to Carbon Paper - Invisible ink for the digital age.

![Carbon Paper on Mac](docs/screenshots/carbon_paper_mac.webp)

![Carbon Paper on Mobile](docs/screenshots/carbon-paper-mobile.webp)

## What is Carbon Paper?

Carbon Paper is a pastebin app that lets you share long pieces of text in confidence. Before uploading your text to the server, it is end-to-end encrypted locally ensuring that nobody, except those whom you share the link with, knows what you wrote.
Expand All @@ -10,9 +14,17 @@ Carbon Paper is a pastebin app that lets you share long pieces of text in confid

Carbon Paper encrypts sender names and paste content with AEAD XChaCha20-Poly1305. If a password is supplied, the paste's key is encrypted by a key derived from the password using Argon2id13. To reduce computational waste, the key encryption key is hashed with Blake3 and sent to the server. On decryption, the server will request the derived key encryption key hash before sending back ciphertext data. The password is not sent anywhere, hashed or otherwise, to prevent bruteforce attacks.

## Developing
## Instances

| URL | Region | Notes |
| ------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------ |
| [paste.whatever.social](https://paste.whatever.social) | Germany | Operated by [Whatever Social](https://whatever.social) and [http.james](https://httpjames.space) |

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
## Deployment

Refer to the wiki for more information.

## Developing

```bash
yarn dev
Expand Down
Binary file added docs/screenshots/carbon-paper-mobile.webp
Binary file not shown.
Binary file added docs/screenshots/carbon_paper_mac.webp
Binary file not shown.

0 comments on commit 9539479

Please sign in to comment.