doc strings typos

Author: jchanvfx

NodeGraphQt/__init__.py

@@ -29,6 +29,47 @@
 # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 # EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+NodeGraphQt is a node graph framework that can be implemented and re purposed
+into applications that supports PySide2.
+
+url: https://github.com/jchanvfx/NodeGraphQt
+docs: http://chantasticvfx.com/nodeGraphQt/html/index.html
+
+Basic Example:
+
+import sys
+from NodeGraphQt import QtWidgets, NodeGraph, BaseNode
+
+
+class MyNode(BaseNode):
+
+    __identifier__ = 'com.chantasticvfx'
+    NODE_NAME = 'My Node'
+
+    def __init__(self):
+        super(MyNode, self).__init__()
+        self.add_input('foo', color=(180, 80, 0))
+        self.add_output('bar')
+
+if __name__ == '__main__':
+    app = QtWidgets.QApplication(sys.argv)
+    graph = NodeGraph()
+
+    graph.register_node(BaseNode)
+    graph.register_node(BackdropNode)
+
+    backdrop = graph.create_node('nodeGraphQt.nodes.Backdrop', name='Backdrop')
+    node_a = graph.create_node('com.chantasticvfx.MyNode', name='Node A')
+    node_b = graph.create_node('com.chantasticvfx.MyNode', name='Node B', color='#5b162f')
+
+    node_a.set_input(0, node_b.output(0))
+
+    viewer = graph.viewer()
+    viewer.show()
+
+    app.exec_()
+"""
 
 try:
     from Qt import QtWidgets, QtGui, QtCore, QtCompat

README.md

@@ -41,10 +41,10 @@ http://chantasticvfx.com/nodeGraphQt/html/index.html
 import sys
 
 from NodeGraphQt import QtWidgets
-from NodeGraphQt import NodeGraph, Node, Backdrop, setup_context_menu
+from NodeGraphQt import NodeGraph, BaseNode, BackdropNode, setup_context_menu
 
 # create a example node object with a input/output port.
-class MyNode(Node):
+class MyNode(BaseNode):
     """example test node."""
 
     # unique node identifier domain. ("com.chantasticvfx.MyNode")
@@ -69,7 +69,7 @@ if __name__ == '__main__':
     setup_context_menu(graph)
 
     # register backdrop node. (included in the NodeGraphQt module)
-    graph.register_node(Backdrop)
+    graph.register_node(BackdropNode)
 
     # register example node into the node graph.
     graph.register_node(MyNode)