hal-browser - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

changelog.md

@@ -1,4 +0,10 @@
-0.0.1 (2018-??-??)
+0.0.2 (2018-07-02)
+=================
+
+* Added styles to package.
+* Bit more docs.
+
+0.0.1 (2018-07-02)
 ==================
 
 * First version

package.json

 {
   "name": "hal-browser",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A HAL browser middleware",
@@ -19,3 +19,4 @@ "main": "dist/index.js",
     "dist",
-    "LICENSE"
+    "LICENSE",
+    "styles"
   ],
@@ -22,0 +23,0 @@ "keywords": [

README.md

@@ -28,4 +28,34 @@ HAL browser
 
-...
+### Curveball
 
+```typescript
+import { Application } from 'curveball/@core';
+import halBrowser from 'hal-browser';
+
+const app = new Application();
+app.use(halBrowser({
+  title: 'HAL Browser',
+  stylesheets: [
+    // path to CSS stylesheets
+  ],
+});
+```
+
+The HAL browser ships with 2 really basic stylesheets in the `styles`
+directory:
+
+* `main.css` - Main interface css
+* `solarized-dark.css` - A syntax highlighting stylesheet lifted from the
+  [Highlight.js][4] project, and originally created by (c) Jeremy Hull
+
+For best effect you'll want both stylesheets!
+
+### Express
+
+TODO
+
+### Koa
+
+TODO
+
 API
@@ -37,1 +67,2 @@ ---
 [3]: https://koajs.com/
+[4]: https://github.com/isagalaev/highlight.js/

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18082

increased by14.44%

Number of package files

12

increased by20%

Lines of code

346

increased by41.22%

Number of lines in readme file

67

increased by86.11%

No dependency changes