Skip to content

Commit 4bde4ea

Browse files
committed
docs: updated e2e link
- added setup instructions for vercel functions/cli - added E2E encrytion related explanation - added sample E2E link
1 parent 455e217 commit 4bde4ea

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
A diff viewer that gives you sharable diff view links but does not store your data. (This takes inspiration from typescript playground how it stores your code in url itself) but the for very large data we will be doing end to end encryption just like `excalidraw` so you can still have sharable links without worrying if you should store your enterprise data or not.
44

55
## :bangbang: No data sent to server
6-
You can take a look at the source code itself. All your data is kept as hash fragment in URL which never makes its way to server. Totally avoiding man in middle and XSS attacks to steal your data or any data breach. The data always stays in your URL and browser and never makes its way on the wire. Thats the main motive behind developing this tool. More about reasoning, why and how can be found in [Motivation](#motivation) section below.
6+
7+
You can take a look at the source code itself. All your data is kept as hash fragment in URL which never makes its way to server. Totally avoiding man in middle and XSS attacks to steal your data or any data breach. The data always stays in your URL and browser and never makes its way on the wire. Thats the main motive behind developing this tool. More about reasoning, why and how can be found in [Motivation](#motivation) section below.
78

89
# Formats currently supported
910

@@ -79,14 +80,19 @@ $ npm run generate
7980
```
8081

8182
## Self Host
83+
8284
This guide provides detailed instructions on how to self-host the offline-diff-viewer application using Docker and Docker Compose. Self-hosting allows you to run the application on your own server, providing you with full control over its environment and configuration.
8385

8486
### Building and Running the Docker Container
87+
8588
1. Build the Docker Image
89+
8690
```bash
8791
$ docker build -t offline-diff-viewer .
8892
```
93+
8994
2. Run the Docker Container via docker run command
95+
9096
```bash
9197
$ docker run -d \
9298
--name offline-diff-viewer \
@@ -100,6 +106,7 @@ $ docker run -d \
100106
```
101107

102108
### Running the Container with Docker Compose
109+
103110
```bash
104111
$ docker compose up -d --build
105-
```
112+
```

0 commit comments

Comments
 (0)