diff --git a/README.md b/README.md index e06eebccc..267db969c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@
- Excalidraw logo: Sketch handrawn like diagrams. + Excalidraw logo: Sketch handrawn like diagrams. -

Virtual whiteboard for sketching hand-drawn like diagrams.

+

Virtual whiteboard for sketching hand-drawn like diagrams.
Collaborative and end to end encrypted.

Follow Excalidraw on Twitter @@ -10,9 +10,6 @@ - - -

@@ -20,13 +17,51 @@ Go to [excalidraw.com](https://excalidraw.com) to start sketching. -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. +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/). + +## Documentation + +### Shortcuts + +You can almost do anything with shortcuts. Click on the help icon on the bottom right corner to see them all. + +### Curved lines and arrows + +Choose line or arrow and click click click instead of drag. + +### Charts + +You can easily create charts by copy pasting data from Excel or just plain comma separated text. + +### Translating + +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. + +Translations will be available on the app if they exceed a certain threshold of completion (currently 85%). + +### Create a collaboration session manually + +In order to create a session manually you just need to generate a link of this form: + +``` +https://excalidraw.com/#room=[0-9a-f]{20},[a-zA-Z0-9_-]{22} +``` + +#### Example + +``` +https://excalidraw.com/#room=91bd46ae3aa84dff9d20,pfLqgEoY1c2ioq8LmGwsFA +``` + +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. + +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. ## Shape libraries Find a growing list of libraries containing assets for your drawings at [libraries.excalidraw.com](https://libraries.excalidraw.com). -## Run the code +## Developement ### Code Sandbox @@ -63,7 +98,7 @@ You can use docker-compose to work on excalidraw locally if you don't want to se docker-compose up --build -d ``` -## Self hosting +### Self hosting 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. @@ -82,45 +117,11 @@ We are working towards providing a full-fledged solution for self hosting your o 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. -## Translating +## Notable used tools -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. - -Translations will be available on the app if they exceed a certain threshold of completion (currently 85%). - -## Excalidraw is built using these awesome tools - -- [React](https://reactjs.org) +- [Create React App](https://github.com/facebook/create-react-app) - [Rough.js](https://roughjs.com) - [TypeScript](https://www.typescriptlang.org) - [Vercel](https://vercel.com) And the main source of inspiration for starting the project is the awesome [Zwibbler](https://zwibbler.com/demo/) app. - -## Testimonials - - - - - - - -## Contributors - -### Code Contributors - -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - -### Financial Contributors - -Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/excalidraw/contribute)] - -#### Individuals - - - -#### Organizations - -Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/excalidraw/contribute)] - - diff --git a/public/og-image-sm.png b/public/og-image-sm.png new file mode 100644 index 000000000..5e88dba05 Binary files /dev/null and b/public/og-image-sm.png differ diff --git a/src/components/ShortcutsDialog.tsx b/src/components/ShortcutsDialog.tsx index 15c57bb2e..84d81efc2 100644 --- a/src/components/ShortcutsDialog.tsx +++ b/src/components/ShortcutsDialog.tsx @@ -94,13 +94,6 @@ const Footer = () => ( > {t("shortcutsDialog.blog")} - - {t("shortcutsDialog.howto")} -