|
1 | | -About |
2 | | ------ |
3 | | -draw.io, this project, is a configurable diagramming/whiteboarding visualization application. draw.io is jointly owned and developed by draw.io Ltd and draw.io AG. |
| 1 | +# draw.io |
4 | 2 |
|
5 | | -As well as running this project, we run a production-grade deployment of the diagramming interface at https://app.diagrams.net. |
| 3 | +## About |
6 | 4 |
|
7 | | -License |
8 | | ------------------ |
| 5 | +draw.io is a configurable diagramming and whiteboarding application, jointly owned and developed by draw.io Ltd (previously named JGraph) and draw.io AG. We also run a production deployment at https://app.diagrams.net. |
9 | 6 |
|
10 | | -The minified code authored by us in this repo is licensed under an Apache v2 license, but not all the sources to build those files are in this repo. This is not an open source project. We do not accept PRs. |
| 7 | +## License |
11 | 8 |
|
12 | | -The JGraph provided icons and diagram templates are licensed under the [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Additional terms may also apply where the icons are originally defined by a third-party copyright holder. We have checked in all cases that the original license allows use in this project. Also see the terms for using the draw.io logo below. |
| 9 | +The source code in this repository is licensed under the [Apache License 2.0](LICENSE). |
13 | 10 |
|
14 | | -Additional minified JavaScript files and Java libraries are used in this project. All of the licenses are deemed compatible with the Apache 2.0, nothing is GPL or AGPL, due diligence is performed on all third-party code. |
| 11 | +The icon sets, stencil libraries, and diagram templates are provided under the following terms: |
15 | 12 |
|
16 | | -We make no copyright claim on the content you create with this software, regardless of the copyright of individual icons used in such content. |
| 13 | +> The icon sets and stencil libraries included in this software, and any derivatives thereof (including conversions to other formats, traced reproductions, substantially similar visual representations, or AI-generated images created using these icons as reference or training input), may not be used as software assets in, distributed for use with, or incorporated into Atlassian products or products distributed through the Atlassian marketplace or plugin ecosystem, without explicit written permission. |
| 14 | +> |
| 15 | +> This restriction does not apply to end-user diagram output (such as exported images or documents) created using this software. |
17 | 16 |
|
18 | | -PRs and use of gen AI |
19 | | ---------------------- |
| 17 | +Some icons are originally defined by third-party copyright holders; we have verified that all original licenses permit use in this project. Additional third-party JavaScript libraries are included, all with licenses compatible with Apache 2.0 (no GPL or AGPL). |
20 | 18 |
|
21 | | -This entire project is written by humans only and written by the core team only. There have been various reasons for this historically, but the key reason from 2024 is that we have no way to determine whether PRs are also human written. |
| 19 | +We make no copyright claim on diagrams you create with this software. |
22 | 20 |
|
23 | | -Scope of the Project |
24 | | --------------------- |
| 21 | +## Contributions |
25 | 22 |
|
26 | | -draw.io is a diagramming or whiteboarding application, depending on which theme is selected. It is not an SVG editing app, the SVG export is designed only for embedding in web pages, not for further editing in other tools. |
| 23 | +We do not accept pull requests. The project is developed entirely by the core team. The entire draw.io editor is human written by the core, full-time development team, no AI generation. |
27 | 24 |
|
28 | | -The application is designed to be entirely as-is. draw.io is not suitable as a framework for building other products from, as source code is not provided. For this try either [Tldraw](https://github.com/tldraw/tldraw) or [Excalidraw](https://github.com/excalidraw/excalidraw). |
| 25 | +## Scope |
29 | 26 |
|
30 | | -Note, in particular, we don't have support for collaborative editing in this project. If this is important, one of the projects above is likely a better choice. |
| 27 | +draw.io is a diagramming and whiteboarding application. It is not an SVG editor. SVG export is intended for embedding in web pages, not for editing in other tools. |
31 | 28 |
|
32 | | -If you are using a draw.io project/product and have issues or questions about the editor itself, the issue tracker and discussion in this GitHub project are likely a good place to look. |
| 29 | +Note that draw.io does not support real-time collaborative editing in this version, currently. |
33 | 30 |
|
34 | | -Running |
35 | | -------- |
| 31 | +For issues or questions about the editor in any draw.io product, the issue tracker and discussions here are a good starting point. |
36 | 32 |
|
37 | | -One way to run draw.io is to fork this project, [publish the master branch to GitHub pages](https://help.github.com/categories/github-pages-basics/) and the [pages sites](https://jgraph.github.io/drawio/src/main/webapp/index.html) will have the full editor functionality (sans the integrations). |
| 33 | +## Running |
38 | 34 |
|
39 | | -Another way is to use [the recommended Docker project](https://github.com/jgraph/docker-drawio) or to download [draw.io Desktop](https://get.diagrams.net). |
| 35 | +Options for running draw.io: |
40 | 36 |
|
41 | | -The full packaged .war of the client and servlets is built when the project is tagged and available on the [releases page](https://github.com/jgraph/draw.io/releases). |
| 37 | +- Fork this repository and [publish to GitHub Pages](https://help.github.com/categories/github-pages-basics/) for a [fully functional editor](https://jgraph.github.io/drawio/src/main/webapp/index.html) (without integrations) |
| 38 | +- Use the [official Docker image](https://github.com/jgraph/docker-drawio) |
| 39 | +- Download [draw.io Desktop](https://get.diagrams.net) |
42 | 40 |
|
43 | | -Supported Browsers |
44 | | ------------------- |
| 41 | +Packaged .war files are available on the [releases page](https://github.com/jgraph/draw.io/releases). |
45 | 42 |
|
46 | | -draw.io supports Chrome 123+, Firefox 120+, Safari 17.5+, Opera 109+, WebView Android 137+, Safari iOS 18.5+ and Edge 123+. |
| 43 | +## Supported Browsers |
47 | 44 |
|
48 | | -Logo and trademark usage |
49 | | ------------------------- |
| 45 | +Chrome 123+, Firefox 120+, Safari 17.5+, Opera 109+, Edge 123+, WebView Android 137+, Safari iOS 18.5+. |
50 | 46 |
|
51 | | -draw.io is a registered EU trademark, #018062448 |
| 47 | +## Trademark |
52 | 48 |
|
53 | | -Do not use the draw.io name or any draw.io logo in a way that suggests you are JGraph, your offering or project is by JGraph, or that JGraph is endorsing you or your offering or project. |
| 49 | +draw.io is a registered EU trademark (#018062448). |
54 | 50 |
|
55 | | -Do not use any draw.io logo as the icon or logo for your business/organization, offering, project, domain name, social media account, or website. |
56 | | - |
57 | | -Do not modify the permitted draw.io logos, including changing the color, dimensions, or combining with other words or design elements. |
58 | | - |
59 | | -Do not use JGraph trademarks or logos without JGraph’s prior written permission. |
| 51 | +Do not use the draw.io name or logo in ways that suggest affiliation with, endorsement by, or sponsorship by draw.io. Do not use draw.io logos for your own business, product, project, domain, or social media presence. Do not modify the draw.io logos. Use of draw.io trademarks requires prior written permission. |
0 commit comments