feat: Switched core foundation

ErikGartner · Dec 23, 2015 · ac23c28 · ac23c28
1 parent 2f45e7d
commit ac23c28
Show file tree

Hide file tree

Showing 9 changed files with 381 additions and 1,320 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,65 @@
+# Contributing to dTree
+
+## Commiting
+Please follow these guidelines.
+
+### Versioning
+dTree uses SemVer 2.0.0. That is the versioning is <MAJOR>.<MINOR>.<PATCH>.
+
+### Commit Message Format
+Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special
+format that includes a **type**, a **scope** and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
+to read on GitHub as well as in various git tools.
+
+### Revert
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+Must be one of the following:
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **docs**: Documentation only changes
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
+  semi-colons, etc)
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **perf**: A code change that improves performance
+* **test**: Adding missing tests
+* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
+  generation
+
+### Scope
+The scope could be anything specifying place of the commit change. For example `$location`,
+`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
+
+### Subject
+The subject contains succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* don't capitalize first letter
+* no dot (.) at the end
+
+### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+
+## Recognitions
+These guidelines are forked from Angular.
diff --git a/README.md b/README.md
@@ -1,9 +1,31 @@
-# dtree
+# dTree
+*A library for visualizing data trees with multiple parents built on top of D3.*
 
-A library for visualizing data trees built on top of D3.
+## Requirements
+To use the library the only dependency is that [D3](https://github.com/mbostock/d3) v3 is loaded first.
 
-[![Travis build status](http://img.shields.io/travis/ErikGartner/dtree.svg?style=flat)](https://travis-ci.org/ErikGartner/dtree)
-[![Code Climate](https://codeclimate.com/github/ErikGartner/dtree/badges/gpa.svg)](https://codeclimate.com/github/ErikGartner/dtree)
-[![Test Coverage](https://codeclimate.com/github/ErikGartner/dtree/badges/coverage.svg)](https://codeclimate.com/github/ErikGartner/dtree)
-[![Dependency Status](https://david-dm.org/ErikGartner/dtree.svg)](https://david-dm.org/ErikGartner/dtree)
-[![devDependency Status](https://david-dm.org/ErikGartner/dtree/dev-status.svg)](https://david-dm.org/ErikGartner/dtree#info=devDependencies)
+## Usage
+Just include the compiled file ```dTree.js```, it exposes a ```dTree``` variable.
+
+To create a graph from data use the following command:
+```
+dTree.init("#target-continer", treeData, options);
+```
+
+## Development
+To setup and build the library from scratch follow these steps:
+1. ```npm install --save-dev```
+2. ```npm run-script build```
+
+A demo is avaible by running:
+```
+npm run-script demo
+```
+
+## Contributions
+To make contributions please follow the contributions document.
+
+## License
+The MIT License (MIT)
+
+Copyright (c) 2015 Erik Gärtner
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
-  "name": "dtree",
+  "name": "dTree",
   "version": "0.0.1",
   "description": "A library for visualizing data trees built on top of D3.",
-  "main": "dist/dtree.js",
+  "main": "dist/dTree.js",
   "scripts": {
     "test": "gulp",
     "test-browser": "gulp test-browser",
@@ -59,8 +59,8 @@
     "serve-static": "^1.0"
   },
   "babelBoilerplateOptions": {
-    "entryFileName": "dtree",
-    "mainVarName": "dtree",
+    "entryFileName": "dTree",
+    "mainVarName": "dTree",
     "mochaGlobals": [
       "stub",
       "spy",