Merge pull request #1 from iVis-at-Bilkent/unstable

Merge unstable to master
iVis-at-Bilkent · Apr 12, 2019 · 6ec476c · 6ec476c
2 parents 37175b3 + 4da62ba
commit 6ec476c
Show file tree

Hide file tree

Showing 15 changed files with 17,076 additions and 1 deletion.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,3 @@
+{
+  "presets": ["env"]
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+npm-debug.log
+nbproject/*
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+node_modules
+npm-debug.log
+package-lock.json
diff --git a/README.md b/README.md
@@ -1 +1,25 @@
-# cose-base
+# cose-base
+
+## Description
+
+This is a core module for compound spring embedder based layout styles such as CoSE-Bilkent, fCoSE, and CiSE.
+
+## Dependencies
+
+ * layout-base ^1.0.0
+
+## Usage instructions
+
+Add `cose-base` as a dependecy to your layout extension.
+
+`require()` in the extension to reach functionality:
+
+ * `var CoSEConstants = require('cose-base').CoSEConstants`,
+ * `var CoSELayout = require('cose-base').CoSELayout`,
+ * `...`
+
+To reach functionality of `layout-base`:
+
+ * `var Integer = require('cose-base').layoutBase.Integer`,
+ * `var Layout = require('cose-base').layoutBase.Layout`,
+ * `...`