Skip to content

Commit 8f576c3

Browse files
committed
updated readme
1 parent 2759e0e commit 8f576c3

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ applications that supports PySide2.
1414

1515
<img src="/docs/_images/screenshot.png" width="100%" title="NodeGraphQt">
1616

17-
#### Documentation
17+
#### API Documentation
1818

19-
<a href="https://jchanvfx.github.io/NodeGraphQt">NodeGraphQt Documentation</a>
19+
https://jchanvfx.github.io/NodeGraphQt
2020

2121
#### Navigation
2222

@@ -84,17 +84,20 @@ if __name__ == '__main__':
8484
graph.register_node(MyNode)
8585

8686
# create nodes.
87-
backdrop = graph.create_node('nodeGraphQt.nodes.Backdrop', name='Backdrop')
8887
node_a = graph.create_node('com.chantasticvfx.MyNode', name='Node A')
8988
node_b = graph.create_node('com.chantasticvfx.MyNode', name='Node B', color='#5b162f')
89+
backdrop = graph.create_node('nodeGraphQt.nodes.Backdrop', name='Backdrop')
9090

91-
# connect node a input to node b output.
91+
# wrap "backdrop" node around "node_a" and "node_b"
92+
backdrop.wrap_nodes([node_a, node_b])
93+
94+
# connect "node_a" input to "node_b" output.
9295
node_a.set_input(0, node_b.output(0))
9396

9497
# auto layout nodes.
9598
graph.auto_layout_nodes()
9699

97-
# get the widget and show.
100+
# show the node graph widget.
98101
graph_widget = graph.widget
99102
graph_widget.show()
100103

0 commit comments

Comments
 (0)