graphkit-js 2.1.4

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012-2014
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+# Graphkit
+
+Graphkit-js is a lightweight JavaScript library that provides robust data structures for directed and undirected multigraphs, along with a collection of algorithms for working with them.
+
+# Installation
+
+## npm
+
+Install via npm:
+
+    $ npm install graphkit-js
+
+## Source Build
+
+To build from source, ensure you have npm installed, then run from the project root:
+
+    $ make dist
+
+# Example
+
+The following example demonstrates basic usage in Node.js:
+
+```js
+const { Graph } = require("graphkit-js");
+
+// Create a new directed graph
+const g = new Graph();
+
+// Add node "a" with no label
+g.setNode("a");
+
+g.hasNode("a");
+// => true
+
+// Add node "b" with a string label
+g.setNode("b", "b's value");
+
+// Get the label for node "b"
+g.node("b");
+// => "b's value"
+
+// Add node "c" with an object label
+g.setNode("c", { k: 123 });
+
+// List all nodes
+g.nodes();
+// => [ 'a', 'b', 'c' ]
+
+// Add a directed edge from "a" to "b"
+g.setEdge("a", "b");
+
+// Add a directed edge with a label
+// Node "d" is created automatically if it does not exist
+g.setEdge("c", "d", { k: 456 });
+
+// List all edges
+g.edges();
+// => [
+//      { v: 'a', w: 'b' },
+//      { v: 'c', w: 'd' }
+//    ]
+
+// Edges leaving node "a"
+g.outEdges("a");
+// => [ { v: 'a', w: 'b' } ]
+
+// Edges connected to node "d"
+g.nodeEdges("d");
+// => [ { v: 'c', w: 'd' } ]
+```
+
+# API Reference
+
+Full API documentation is available in the project Wiki.
+
+# Bug Reports
+
+Found a bug or have a feature request?
+Please open an issue here:
+
+👉 https://github.com/GRAPHKITORG/graphkit-js/issues
+
+# Contributing
+
+Contributions are welcome! Please submit pull requests or open issues to discuss proposed changes.
+
+# License
+
+Graphkit-js is licensed under the terms of the MIT License. See the
+[LICENSE](LICENSE) file
+for details.
+
+[npm package manager]: http://npmjs.org/