Skip to content

Commit df97e09

Browse files
authored
Demo video in README and docs (#119)
1 parent 6ffc265 commit df97e09

File tree

2 files changed

+10
-15
lines changed

2 files changed

+10
-15
lines changed

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ Available here!
1818

1919
https://merrimanind.github.io/drawpyo/
2020

21-
# Discord Server
22-
23-
https://discord.gg/CSMHupUvRp
24-
2521
# Basic Usage
2622

2723
The basic mode of interacting with drawpyo is to manually create, style, and place objects just like you would using the Draw.io UI. There are a number of ways to style objects and you can write your own functionality for automatically handling style or placement.
@@ -72,19 +68,13 @@ file.write()
7268

7369
Drawpyo also provides higher-level functionality that goes beyond what the Draw.io app offers. These **diagram types** allow you to generate complete structures automatically, without manually placing every element.
7470

75-
Currently, Drawpyo supports:
71+
This video demonstrates an exemplary automatic diagram layout process:
7672

77-
* **Tree Diagrams**
78-
* **Binary Tree Diagrams**
79-
* **Bar Charts**
80-
* **Pie Charts**
81-
* **Color Legends**
73+
[<img src="https://img.youtube.com/vi/HwUqUZZVMgQ/hqdefault.jpg" width="480" height="270"
74+
/>](https://www.youtube.com/embed/HwUqUZZVMgQ)
8275

8376
For more details, refer to the [documentation](https://merrimanind.github.io/drawpyo/).
8477

85-
Work has also begun on additional diagram types, including:
78+
## Contributions
8679

87-
* Automatic class/object/inheritance diagrams from a Python module
88-
* Directed and undirected graphs from adjacency lists
89-
* Flowcharts
90-
* Process diagrams
80+
Contributions are welcome. See the [contribution guidelines](CONTRIBUTING.md) or join our [Discord server](https://discord.gg/CSMHupUvRp) for more information.

docs/about.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ See the full documentation for these functions in [Basic Diagrams - Usage](usage
1414

1515
Drawpyo extends the basic functionality of the Draw.io app with custom diagram types. These custom diagrams have automated styling and layouting to make common or complex diagrams easier to generate.
1616

17+
This video demonstrates an exemplary automatic diagram layout process:
18+
19+
[<img src="https://img.youtube.com/vi/HwUqUZZVMgQ/hqdefault.jpg" width="480" height="270"
20+
/>](https://www.youtube.com/embed/HwUqUZZVMgQ)
21+
1722
## TreeDiagram
1823

1924
This diagram makes creating directed tree graphs easy. Define trees, nodes, and then apply an auto layout.

0 commit comments

Comments
 (0)