|
@@ -1,8 +1,8 @@
|
1
|
1
|
<div align="center" style="display:flex;flex-direction:column;">
|
2
|
2
|
<a href="https://excalidraw.com">
|
3
|
|
- <img src="./public/og-image.png" alt="Excalidraw logo: Sketch handrawn like diagrams." />
|
|
3
|
+ <img width="540" src="./public/og-image-sm.png" alt="Excalidraw logo: Sketch handrawn like diagrams." />
|
4
|
4
|
</a>
|
5
|
|
- <h3>Virtual whiteboard for sketching hand-drawn like diagrams.</h3>
|
|
5
|
+ <h3>Virtual whiteboard for sketching hand-drawn like diagrams.<br>Collaborative and end to end encrypted.</h3>
|
6
|
6
|
<p>
|
7
|
7
|
<a href="https://twitter.com/Excalidraw">
|
8
|
8
|
<img alt="Follow Excalidraw on Twitter" src="https://img.shields.io/twitter/follow/excalidraw.svg?label=follow+excalidraw&style=social&logo=twitter">
|
|
@@ -10,9 +10,6 @@
|
10
|
10
|
<a target="_blank" href="https://crowdin.com/project/excalidraw">
|
11
|
11
|
<img src="https://badges.crowdin.net/excalidraw/localized.svg">
|
12
|
12
|
</a>
|
13
|
|
- <a target="_blank" href="https://hub.docker.com/r/excalidraw/excalidraw">
|
14
|
|
- <img src="https://img.shields.io/docker/pulls/excalidraw/excalidraw">
|
15
|
|
- </a>
|
16
|
13
|
</p>
|
17
|
14
|
</div>
|
18
|
15
|
|
|
@@ -20,13 +17,51 @@
|
20
|
17
|
|
21
|
18
|
Go to [excalidraw.com](https://excalidraw.com) to start sketching.
|
22
|
19
|
|
23
|
|
-Read our [blog](https://blog.excalidraw.com) and follow the [guides](https://howto.excalidraw.com) to learn more about Excalidraw and how to use it effectively.
|
|
20
|
+Read the latest news and updates on our [blog](https://blog.excalidraw.com). A good start is to see all the updates of [One Year of Excalidraw](https://blog.excalidraw.com/one-year-of-excalidraw/).
|
|
21
|
+
|
|
22
|
+## Documentation
|
|
23
|
+
|
|
24
|
+### Shortcuts
|
|
25
|
+
|
|
26
|
+You can almost do anything with shortcuts. Click on the help icon on the bottom right corner to see them all.
|
|
27
|
+
|
|
28
|
+### Curved lines and arrows
|
|
29
|
+
|
|
30
|
+Choose line or arrow and click click click instead of drag.
|
|
31
|
+
|
|
32
|
+### Charts
|
|
33
|
+
|
|
34
|
+You can easily create charts by copy pasting data from Excel or just plain comma separated text.
|
|
35
|
+
|
|
36
|
+### Translating
|
|
37
|
+
|
|
38
|
+To translate Excalidraw into other languages, please visit [our Crowdin page](https://crowdin.com/project/excalidraw). To add a new language, [open an issue](https://github.com/excalidraw/excalidraw/issues/new) so we can get things set up on our end first.
|
|
39
|
+
|
|
40
|
+Translations will be available on the app if they exceed a certain threshold of completion (currently 85%).
|
|
41
|
+
|
|
42
|
+### Create a collaboration session manually
|
|
43
|
+
|
|
44
|
+In order to create a session manually you just need to generate a link of this form:
|
|
45
|
+
|
|
46
|
+```
|
|
47
|
+https://excalidraw.com/#room=[0-9a-f]{20},[a-zA-Z0-9_-]{22}
|
|
48
|
+```
|
|
49
|
+
|
|
50
|
+#### Example
|
|
51
|
+
|
|
52
|
+```
|
|
53
|
+https://excalidraw.com/#room=91bd46ae3aa84dff9d20,pfLqgEoY1c2ioq8LmGwsFA
|
|
54
|
+```
|
|
55
|
+
|
|
56
|
+The first set of digits is the room. This is visible from the server that’s going to dispatch messages to everyone that knows this number.
|
|
57
|
+
|
|
58
|
+The second set of digits is the encryption key. The Excalidraw server doesn’t know about it. This is what all the participants use to encrypt/decrypt the messages.
|
24
|
59
|
|
25
|
60
|
## Shape libraries
|
26
|
61
|
|
27
|
62
|
Find a growing list of libraries containing assets for your drawings at [libraries.excalidraw.com](https://libraries.excalidraw.com).
|
28
|
63
|
|
29
|
|
-## Run the code
|
|
64
|
+## Developement
|
30
|
65
|
|
31
|
66
|
### Code Sandbox
|
32
|
67
|
|
|
@@ -63,7 +98,7 @@ You can use docker-compose to work on excalidraw locally if you don't want to se
|
63
|
98
|
docker-compose up --build -d
|
64
|
99
|
```
|
65
|
100
|
|
66
|
|
-## Self hosting
|
|
101
|
+### Self hosting
|
67
|
102
|
|
68
|
103
|
We publish a Docker image with the Excalidraw client at [excalidraw/excalidraw](https://hub.docker.com/r/excalidraw/excalidraw). You can use it to self host your own client under your own domain, on Kubernetes, AWS ECS, etc.
|
69
|
104
|
|
|
@@ -82,45 +117,11 @@ We are working towards providing a full-fledged solution for self hosting your o
|
82
|
117
|
|
83
|
118
|
Pull requests are welcome. For major changes, please [open an issue](https://github.com/excalidraw/excalidraw/issues/new) first to discuss what you would like to change.
|
84
|
119
|
|
85
|
|
-## Translating
|
86
|
|
-
|
87
|
|
-To translate Excalidraw into other languages, please visit [our Crowdin page](https://crowdin.com/project/excalidraw). To add a new language, [open an issue](https://github.com/excalidraw/excalidraw/issues/new) so we can get things set up on our end first.
|
88
|
|
-
|
89
|
|
-Translations will be available on the app if they exceed a certain threshold of completion (currently 85%).
|
|
120
|
+## Notable used tools
|
90
|
121
|
|
91
|
|
-## Excalidraw is built using these awesome tools
|
92
|
|
-
|
93
|
|
-- [React](https://reactjs.org)
|
|
122
|
+- [Create React App](https://github.com/facebook/create-react-app)
|
94
|
123
|
- [Rough.js](https://roughjs.com)
|
95
|
124
|
- [TypeScript](https://www.typescriptlang.org)
|
96
|
125
|
- [Vercel](https://vercel.com)
|
97
|
126
|
|
98
|
127
|
And the main source of inspiration for starting the project is the awesome [Zwibbler](https://zwibbler.com/demo/) app.
|
99
|
|
-
|
100
|
|
-## Testimonials
|
101
|
|
-
|
102
|
|
-<a href="https://twitter.com/Lissy_Sykes/status/1213813117177729026"><img width="398" src="https://user-images.githubusercontent.com/197597/71783813-dbf8a600-2fa0-11ea-9c0d-bb3cc45969e6.png"></a> <a href="https://twitter.com/dan_abramov/status/1213762494428262400"><img width="398" src="https://user-images.githubusercontent.com/197597/71783990-4d395880-2fa3-11ea-9ad7-186138db5003.png"></a>
|
103
|
|
-
|
104
|
|
-<a href="https://twitter.com/kyehohenberger/status/1214288572037025792"><img width="423" src="https://user-images.githubusercontent.com/197597/71851802-34f13880-308c-11ea-9416-191099e6349c.png"></a> <a href="https://twitter.com/lucasazzola/status/1215126440330416128"><img width="429" src="https://user-images.githubusercontent.com/197597/72039003-48e99580-3258-11ea-8daa-85dd055f2a82.png">
|
105
|
|
-
|
106
|
|
-<a href="https://twitter.com/jordwalke/status/1214858186789806080"><img width="434" src="https://user-images.githubusercontent.com/197597/72036874-07a1b780-3251-11ea-99e8-6bafd93483a0.png"></a>
|
107
|
|
-
|
108
|
|
-## Contributors
|
109
|
|
-
|
110
|
|
-### Code Contributors
|
111
|
|
-
|
112
|
|
-This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. <a href="https://github.com/excalidraw/excalidraw/graphs/contributors"><img src="https://opencollective.com/excalidraw/contributors.svg?width=890&button=false" /></a>
|
113
|
|
-
|
114
|
|
-### Financial Contributors
|
115
|
|
-
|
116
|
|
-Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/excalidraw/contribute)]
|
117
|
|
-
|
118
|
|
-#### Individuals
|
119
|
|
-
|
120
|
|
-<a href="https://opencollective.com/excalidraw"><img src="https://opencollective.com/excalidraw/individuals.svg?width=890&button=true" /></a>
|
121
|
|
-
|
122
|
|
-#### Organizations
|
123
|
|
-
|
124
|
|
-Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/excalidraw/contribute)]
|
125
|
|
-
|
126
|
|
-<a href="https://opencollective.com/excalidraw/organization/0/website"><img src="https://opencollective.com/excalidraw/organization/0/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/1/website"><img src="https://opencollective.com/excalidraw/organization/1/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/2/website"><img src="https://opencollective.com/excalidraw/organization/2/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/3/website"><img src="https://opencollective.com/excalidraw/organization/3/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/4/website"><img src="https://opencollective.com/excalidraw/organization/4/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/5/website"><img src="https://opencollective.com/excalidraw/organization/5/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/6/website"><img src="https://opencollective.com/excalidraw/organization/6/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/7/website"><img src="https://opencollective.com/excalidraw/organization/7/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/8/website"><img src="https://opencollective.com/excalidraw/organization/8/avatar.svg"></a> <a href="https://opencollective.com/excalidraw/organization/9/website"><img src="https://opencollective.com/excalidraw/organization/9/avatar.svg"></a>
|