graphflux 0.0.1-beta

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012-2014 John Williams
+
+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,102 @@
+graphflux is a JavaScript library for creating and modifying directed and undirected graphs. In addition to a core graph API, it also comes with implementations for many common graph algorithms.
+
+# Table of Contents
+
+- [Example](#example)
+- [Installing](#installing)
+  - [npm Install](#npm-install)
+  - [Bower Install](#bower-install)
+  - [Browser Scripts](#browser-scripts)
+  - [Source Build](#source-build)
+- [[API Reference]]
+- [Bug Tracking](/johntech0828/graphflux/issues)
+- [[Contributing]]
+- [License](#license)
+
+## Example
+
+This following code block shows a small example of how to use graphflux in node.js:
+
+```js
+var Graph = require("graphflux").Graph;
+
+// Create a new directed graph
+var g = new Graph();
+
+// Add node "a" to the graph with no label
+g.setNode("a");
+
+g.hasNode("a");
+// => true
+
+// Add node "b" to the graph 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" to the graph with an Object label
+g.setNode("c", { k: 123 });
+
+// What nodes are in the graph?
+g.nodes();
+// => `[ 'a', 'b', 'c' ]`
+
+// Add a directed edge from "a" to "b", but assign no label
+g.setEdge("a", "b");
+
+// Add a directed edge from "c" to "d" with an Object label.
+// Since "d" did not exist prior to this call it is automatically
+// created with an undefined label.
+g.setEdge("c", "d", { k: 456 });
+
+// What edges are in the graph?
+g.edges();
+// => `[ { v: 'a', w: 'b' },
+//       { v: 'c', w: 'd' } ]`.
+
+// Which edges leave node "a"?
+g.outEdges("a");
+// => `[ { v: 'a', w: 'b' } ]`
+
+// Which edges enter and leave node "d"?
+g.nodeEdges("d");
+// => `[ { v: 'c', w: 'd' } ]`
+```
+
+or graphflux can be included in a webpage:
+
+```html
+<script src="http://PATH/TO/graphflux.min.js"></script>
+ <script>
+var g = new graphflux.Graph();
+// ...etc.
+```
+
+## Installing
+
+### npm Install
+
+Before installing this library you need to install the [npm package manager](http://npmjs.org/).
+
+To get graphflux from npm, use:
+
+    $ npm install graphflux
+
+### Source Build
+
+Before building this library you need to install the [npm package manager](http://npmjs.org/).
+
+Check out this project and run this command from the root of the project:
+
+    $ make dist
+
+This will generate `graphflux.js` and `graphflux.min.js` in the `dist` directory
+of the project.
+
+# License
+
+graphflux is licensed under the terms of the MIT License. See the [LICENSE](LICENSE) file for details.
+
+[npm package manager]: http://npmjs.org/