Merge pull request #200 from bustlelabs/cleanup

Remove unused files, remove packages from package.json, docs
bustle · Nov 2, 2015 · 437baaf · 437baaf
2 parents e0b7e0e + fce0dc4
commit 437baaf
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 208 deletions.
diff --git a/README.md b/README.md
@@ -226,31 +226,13 @@ Or run headless tests via testem:
 
   * `npm test`
 
-To quickly view the demo:
+#### Demo
 
-  * `broccoli serve`
-  * open http://localhost:4200/demo
-  * Image uploads and embeds are not supported running in this manner.
-
-To view the full demo with uploads and embed, you will have to configure AWS
-and Embedly keys as environment variables:
-
-```bash
-export AWS_ACCESS_KEY_ID=XXXXXX
-export AWS_SECRET_ACCESS_KEY=XXXXXX
-export EMBEDLY_KEY=XXXXXX
-```
-
-Also set the `bucketName` in `server/config.json` with the name of your AWS
-S3 bucket for uploading files.
-
-Then to boot the server:
-
-```
-node server/index.js
-```
+There is a demo app that uses content-kit and ember-content-kit in `demo/`. To run the demo:
 
-And visit [localhost:5000/dist/demo/index.html](http://localhost:5000/dist/demo/index.html)
+ * `cd demo/ && npm install && bower install`
+ * `ember serve` (shut down your broccoli server if it is already running on port 4200)
+ * visit http://localhost:4200/
 
 #### Releasing
 
@@ -259,7 +241,7 @@ And visit [localhost:5000/dist/demo/index.html](http://localhost:5000/dist/demo/
 * `git push <origin> --follow-tags`
 * `npm publish`
 
-#### Re-deploy the demo
+#### Deploy the demo
 
 The demo website is hosted at github pages. To publish a new version:
 

diff --git a/notes b/notes
diff --git a/package.json b/package.json
@@ -3,9 +3,6 @@
   "version": "0.5.0-beta2",
   "description": "A modern, minimalist WYSIWYG editor.",
   "repository": "https://github.com/bustlelabs/content-kit-editor",
-  "engines": {
-    "node": "0.10.x"
-  },
   "scripts": {
     "start": "broccoli serve",
     "test": "testem ci",
@@ -30,12 +27,6 @@
   ],
   "author": "Garth Poitras <garth22@gmail.com> (http://garthpoitras.com/)",
   "license": "MIT",
-  "dependencies": {
-    "aws-sdk": "^2.1.7",
-    "busboy": "^0.2.9",
-    "embedly": "^1.0.2",
-    "express": "^4.11.1"
-  },
   "devDependencies": {
     "broccoli": "^0.16.3",
     "broccoli-funnel": "^0.2.8",
@@ -45,8 +36,6 @@
     "broccoli-test-builder": "^0.1.0",
     "content-kit-utils": "^0.2.0",
     "jquery": "^2.1.4",
-    "mobiledoc-dom-renderer": "^0.1.12",
-    "mobiledoc-html-renderer": "^0.1.7",
     "testem": "^0.8.4"
   },
   "main": "dist/commonjs/content-kit-editor/index.js"

diff --git a/server/config.json b/server/config.json
diff --git a/server/index.js b/server/index.js
diff --git a/server/services/upload.js b/server/services/upload.js
diff --git a/src/js/parsers/mobiledoc.js b/src/js/parsers/mobiledoc.js
@@ -7,15 +7,18 @@ import {
 import { kvArrayToObject, filter } from "../utils/array-utils";
 
 /*
- * input mobiledoc: [ markers, elements ]
- * output: Post
- *
+ * Parses from mobiledoc -> post
  */
 export default class MobiledocParser {
   constructor(builder) {
     this.builder = builder;
   }
 
+  /**
+   * @method parse
+   * @param {Mobiledoc}
+   * @return {Post}
+   */
   parse({version, sections: sectionData}) {
     const markerTypes = sectionData[0];
     const sections    = sectionData[1];

diff --git a/src/js/renderers/mobiledoc.js b/src/js/renderers/mobiledoc.js
@@ -106,7 +106,15 @@ const postOpcodeCompiler = {
   }
 };
 
+/**
+ * Render from post -> mobiledoc
+ */
 export default {
+  /**
+   * @method render
+   * @param {Post}
+   * @return {Mobiledoc}
+   */
   render(post) {
     let opcodes = [];
     visit(visitor, post, opcodes);