Permalink
Browse files

infrastructure

  • Loading branch information...
harlantwood committed Aug 22, 2015
0 parents commit f475590e47ac2a882f7b3342678b3d5267607d2b
Showing with 105 additions and 0 deletions.
  1. +5 −0 .gitignore
  2. +5 −0 .npmignore
  3. +20 −0 MIT-LICENSE.md
  4. +35 −0 README.md
  5. +40 −0 package.json
@@ -0,0 +1,5 @@
+/.env
+/node_modules/
+/tmp/
+.DS_Store
+npm-debug.log
@@ -0,0 +1,5 @@
+/.env
+/node_modules/
+/tmp/
+.DS_Store
+npm-debug.log
@@ -0,0 +1,20 @@
+Copyright 2015 [The Authors](https://github.com/nodesphere/nodesphere/graphs/contributors)
+
+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.
@@ -0,0 +1,35 @@
+# Nodesphere
+
+> Note: Nodesphere is currently pre-alpha, and things are likely to change. We don't recommend you use it in production yet.
+
+Nodesphere is an interchange format for node networks. It has three primary objectives:
+
+1. Create interoperability among graph visualization interfaces
+2. Provide adaptors to connect these interfaces to personal data ecosystems,
+including social network data, online drives, and ultimately, any public or private data
+3. Abstract data storage and retrieval, allowing transitions
+from traditional server & database systems toward secure, distributed public and private storage,
+as these systems become practical and performant
+
+## Philosophical
+
+Everything we want to share is a graph, which can be seen as a group of knowledge nodes.
+We think of this as a "sphere" of nodes; thus the name _nodesphere_.
+Nodesphere is designed to help enable the curation, sharing, visualization, and navigation of all your graph data.
+
+## Development
+
+### In the browser
+
+If you are creating a client side application using Nodesphere, consider using
+polyfills to ensure maximum browser compatibility.
+For example, include this line before all other javascript tags:
+
+<script src="//cdn.polyfill.io/v1/polyfill.min.js"></script>
+
+We build with browserify. Webpack or similar should work fine too.
+
+## Notes
+
+- Both Nodes and Edges are implemented as _maps_, or sets of key-value pairs.
+- Edges have the special keys `start` and `end` which point to those respective nodes.
@@ -0,0 +1,40 @@
+{
+ "name": "nodesphere",
+ "version": "0.5.0-dev",
+ "description": "graph interoperability",
+ "main": "lib/exports.coffee",
+ "scripts": {
+ },
+ "author": "Harlan T Wood <code@nodesphere.org> (http://nodesphere.org/)",
+ "contributors": [
+ "Jack Senechal (https://github.com/jacksenechal)"
+ ],
+ "license": "MIT",
+ "engines": {
+ "node": "0.10.31",
+ "npm": "^2.5"
+ },
+ "dependencies": {
+ "bluebird": "^2.9.34",
+ "coffee-script": "^1.8.0",
+ "lightsaber": "^0.4.0",
+ "lodash": "^3.10.0",
+ "xhr": "^2.0.3"
+ },
+ "devDependencies": {
+ },
+ "repository": {
+ "type": "git",
+ "url": "git@github.com:nodesphere/nodesphere.git"
+ },
+ "keywords": [
+ "blockchain",
+ "content-addressable",
+ "edge",
+ "graph",
+ "node"
+ ],
+ "bugs": {
+ "url": "https://github.com/nodesphere/nodesphere/issues"
+ }
+}

0 comments on commit f475590

Please sign in to comment.