aboutsummaryrefslogtreecommitdiff
path: root/node_modules/topo/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/topo/README.md')
-rwxr-xr-xnode_modules/topo/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/topo/README.md b/node_modules/topo/README.md
new file mode 100755
index 00000000..fa04098a
--- /dev/null
+++ b/node_modules/topo/README.md
@@ -0,0 +1,29 @@
+# topo
+
+Topological sorting with grouping support.
+
+[![Build Status](https://secure.travis-ci.org/hapijs/topo.svg?branch=master)](http://travis-ci.org/hapijs/topo)
+
+Lead Maintainer: [Devin Ivy](https://github.com/devinivy)
+
+## Usage
+
+See the [API Reference](API.md)
+
+**Example**
+```node
+const Topo = require('topo');
+
+const morning = new Topo();
+
+morning.add('Nap', { after: ['breakfast', 'prep'] });
+
+morning.add([
+ 'Make toast',
+ 'Pour juice'
+], { before: 'breakfast', group: 'prep' });
+
+morning.add('Eat breakfast', { group: 'breakfast' });
+
+morning.nodes; // ['Make toast', 'Pour juice', 'Eat breakfast', 'Nap']
+```