readme update

licensing update

Author: KeithWoods

ReadMe.md

@@ -3,11 +3,38 @@
 
 # Evented State Processor (ESP) Dev Tools
 
-Dev tools coming soon. Watch this space...
+The esp-js devtools give you the ability to monitor activity of all models in all routers.
+
+Features:
+* A real-time view of events and errors as they are processed by your models.
+* Ability to zoom to the nth degree.
+* Ability to log the entire event to the browsers console.
+* Can be opened and closed (it's currently implemented as a floating div).
+
+![screenshot](./screenshots/screenshot.png)
+
+# Installation
+Install from npm: `npm install --save esp-js-devtools`.
+
+Wire it up early on in your app:
+
+```
+import espDevTools from 'esp-js-devtools';
+espDevTools.registerDevTools();
+```
+
+# Activation 
+
+It's activate using a keyboard shortcut: `ctrl + alt + d`. 
+
+#  Demo
+
+For a demo check out the esp port of the [react chat app](https://github.com/esp/esp-js/tree/master/examples/esp-chat-react-es6).
 
 # ESP Documentation
 
 [http://esp.readthedocs.org](http://esp.readthedocs.org).
 
-# Installation
-Install from npm: `npm install esp-js-devtools --save`.
+# Licence 
+
+Apache 2

screenshots/screenshot.png

@@ -1,3 +1,21 @@
+// notice_start
+/*
+ * Copyright 2015 Dev Shop Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// notice_end
+
 import $ from 'jquery';
 import esp from 'esp-js';
 import AnalyticsMonitor from './model/analyticsMonitor';

src/devtoolsHooks.js

@@ -1,3 +1,21 @@
+// notice_start
+/*
+ * Copyright 2015 Dev Shop Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// notice_end
+
 import { registerDevTools } from './devtoolsHooks';
 export { registerDevTools };
 export default {

src/index.js

@@ -1,3 +1,21 @@
+// notice_start
+/*
+ * Copyright 2015 Dev Shop Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// notice_end
+
 import DebugToolsModel from './devToolsModel';
 
 export default class AnalyticsMonitor {

src/model/analyticsMonitor.js

@@ -1,3 +1,21 @@
+// notice_start
+/*
+ * Copyright 2015 Dev Shop Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// notice_end
+
 import DataPointType from './dataPointType';
 let dataPointId = 1;
 

src/model/dataPoint.js

@@ -1,3 +1,21 @@
+// notice_start
+/*
+ * Copyright 2015 Dev Shop Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// notice_end
+
 export default class DataPointType {
     static get eventPublished() { return 'eventPublished'; };
     static get routerHalted() { return 'routerHalted'; };

src/model/dataPointType.js

@@ -1,3 +1,21 @@
+// notice_start
+/*
+ * Copyright 2015 Dev Shop Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// notice_end
+
 import esp from 'esp-js';
 import _ from 'lodash';
 import moment from 'moment';

src/model/devToolsModel.js

@@ -1,3 +1,21 @@
+// notice_start
+/*
+ * Copyright 2015 Dev Shop Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// notice_end
+
 import moment from 'moment';
 import DataPoint from './dataPoint';
 
@@ -22,12 +40,4 @@ export default class RegisteredModel {
     set haltingError(err) {
         this._haltingError = err;
     }
-    //createEventPublishedDataPoint(eventNumber, modelId, eventType) {
-    //    var dataPoint = new DataPoint(eventNumber, moment(), eventType, modelId);
-    //    this._events.push(dataPoint);
-    //    return eventRecord;
-    //}
-    //halted(eventNumber, modelId, eventType) {
-    //
-    //}
 }

src/model/registeredModel.js

@@ -1,3 +1,21 @@
+// notice_start
+/*
+ * Copyright 2015 Dev Shop Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// notice_end
+
 class UpdateType {
     static get none() { return 'none'; };
     static get modelsChanged() { return 'modelsChanged'; };