panic-client - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "panic-client",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Test client for panic-server",
   "main": "src/index.js",
   "dependencies": {
-    "object-assign-deep": "0.0.4",
     "platform": "^1.3.1",
@@ -12,7 +11,8 @@ "socket.io-client": "^1.4.5"
   "devDependencies": {
-    "jasmine": "^2.4.1",
+    "chai": "^3.5.0",
+    "mocha": "^2.4.5",
     "webpack": "^1.12.14"
   },
   "scripts": {
-    "test": "jasmine",
+    "test": "mocha",
     "build": "webpack --watch"
@@ -19,0 +19,0 @@ },

README.md

 Panic Client
 ------------
+*Lightweight client for panic-server*
 
-> This is meant to be used alongside [panic-server](https://github.com/gundb/panic-server).
+[![npm](https://img.shields.io/npm/dt/panic-client.svg?style=flat-square)](https://www.npmjs.com/package/panic-client)
+[![Travis branch](https://img.shields.io/travis/PsychoLlama/panic-client/master.svg?style=flat-square)](https://travis-ci.org/PsychoLlama/panic-client)
+[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/amark/gun)
+[![npm](https://img.shields.io/npm/v/panic-client.svg?style=flat-square)](https://www.npmjs.com/package/panic-client)
 
-## What it is
-Panic is a distributed test framework built for [gunDB](https://github.com/amark/gun) to test end-to-end functionality, such as client/client interactions. Other E2E test frameworks focus more on a single browser. While valuable, collaborative apps are nearly impossible to test. For example:
+## Docs
+Since this library is just support for [panic-server](https://github.com/gundb/panic-server), you can find the majority of the documentation [over there](https://github.com/gundb/panic-server/blob/master/README.md).
 
-```
-browsers A and B connect to server C
-browser A performs action and is done
-server C sees action and is done
-browser B sees action and is done
+## Installing
+Panic-client is hosted on [npm](https://www.npmjs.com/package/panic-client), and can be installed by running this in your terminal:
 
-3 cases finished, no failures. Next test.
+```bash
+npm install panic-client
 ```
 
-So while many test frameworks will focus on one of those peers, no test framework includes them all. This is a true end-to-end framework, and without it, real-time data sync has been a nightmare to test against.
+> If you're not familiar with npm, you can learn more by [clicking here](https://docs.npmjs.com/getting-started/what-is-npm), or you can install it by following [these instructions](http://blog.npmjs.org/post/85484771375/how-to-install-npm).
 
 ## Usage
+Panic-client's API surface area is pretty small, since it's just a small wrapper around [socket.io](http://socket.io/). It consists of one method, `server`, and two properties, `connection` and `platform`.
 
-> **Warning:** panic is still under development.
+There are two ways to include it in your code, depending on your environment...
 
-Download [panic-server](https://github.com/PsychoLlama/panic-server.git), that's where the tests are written. To connect to the panic dispatcher, first include the panic src:
+**Node.js**
+```javascript
+// simply import it.
+var panic = require('panic-client')
+```
 
-```bash
-npm install PsychoLlama/panic-client
+**Browser**
+
+> If you're using [panic-server](https://github.com/gundb/panic-server), the server automatically delivers the browser file at the at the port/hostname you configured. By default, it will be 'http://localhost:8080/panic.js'.
+
+If you're not using [panic-server](https://github.com/gundb/panic-server), it may be more complicated, depending on your file structure. If you're using [webpack](https://github.com/webpack/webpack), simply include it the same way as you would on Node.js. Otherwise, the browser build is located at root level, named `panic.js`. Simply point a script tag there, or copy it into your project root...
+
+```html
+<script src="node_modules/{path to panic-client}/panic.js"></script>
+<script>
+	panic; // now exposed as a global variable
+</script>
 ```
 
-**Browser:**
+Best practice is to load through panic-server.
+
 ```html
-<script src="panic.js"></script>
-<!-- this will expose the "panic" global -->
-
+<script src="http://localhost:8080/panic.js"></script>
 ```
-**Node.js:**
-```javascript
-var panic = require('panic-client');
-```
 
-Now all that's left is connecting to the panic server:
+### `.server(String)`
+This method attempts to connect to your panic-server host, and allows panic-server to run code on your machine in real-time. Just give it the url.
 
 ```javascript
-// panic will default to this address
+// This is the default url.
+// When connecting from another computer,
+// exchange `localhost` with your ip address.
 panic.server('http://localhost:8080')
 ```
 
-The tests should begin automatically.
+### `.connection`
+`panic.connection` is the websocket opened to panic-server. If you haven't called `panic.server()` yet, it'll be `null`.
 
+### `.platform`
+The `panic.platform` object is created by [platform.js](https://github.com/bestiejs/platform.js/), and contains information about what environment the code is running on.
 
-## Reference
-
-- TDO - Test Description Object
-  - Description
-  - Id
-  - Configuration object
-    - an environment object
-    - callbacks and conditionals
-
+## Support
+If you have questions or ideas, please let us know on [our gitter channel](https://gitter.im/amark/gun) :grinning:

src/index.js

 /*jslint node: true*/
 'use strict';
 
-var panic = require('./framework/panic');
+var panic = require('./panic');
 
@@ -6,0 +6,0 @@ if (typeof window !== 'undefined') {

webpack.config.js

@@ -1,2 +0,2 @@
-/*jslint node: true, nomen: true*/
+'use strict';
 var path = require('path');
@@ -3,0 +3,0 @@

No alert changes

Improved metrics

Dependency count

2

decreased by-33.33%

Number of lines in readme file

70

increased by16.67%

Worsened metrics

Total package byte prevSize

251289

decreased by-19.49%

Dev dependency count

3

increased by50%

Number of package files

13

decreased by-31.58%

Lines of code

8017

decreased by-17.52%

Dependency changes

• - Removedobject-assign-deep@0.0.4

• - Removedobject-assign@2.0.0(transitive)

• - Removedobject-assign-deep@0.0.4(transitive)

• - Removedunderscore@1.7.0(transitive)