hal-browser is now @curveball/browser

Author: evert

README.md

@@ -1,23 +1,25 @@
-HAL browser
-===========
+Curveball Browser
+=================
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/evert/hal-browser.svg)](https://greenkeeper.io/)
+This package provides a middleware that automatically turns JSON responses
+from an API into HTML responses.
 
-This package provides a middleware for HAL APIs.
+It will do so by looking if the API was accessed by a HTTP client that prefers
+HTML. Browsers do this by sending an `Accept: text/html` header.
 
-The middleware looks for HAL and JSON responses, and automatically converts
-them into a HTML interface if a browser access them.
+If this middleware spots this, it will kick in and auto-generate a great looing
+HTML document.
 
-It does so via the `Accept: text/html` header. If this header is not provided,
-the middleware does nothing.
+If this header was not provides, this middleware does nothing.
 
 It automatically decorates the following formats:
 
 * `application/json`
 * `application/problem+json`
 * `application/hal+json`
 * `text/markdown`
-
+* `text/csv`
+* `application/prs.hal-forms+json`
 
 Screenshot
 ----------
@@ -87,12 +89,12 @@ An example. If a API normally returns the following HAL format:
 
 The browser will automatically convert it to this HTML format:
 
-![Screenshot from 0.7.0](https://github.com/evert/hal-browser/blob/master/screenshots/0.7.0.png)
+![Screenshot from 0.9.1](https://github.com/evert/hal-browser/blob/master/screenshots/0.9.1.png)
 
 This screenshot is an example of the browser automatically formatting a .csv
 and parsing HTTP `Link` headers:
 
-![Screenshot from 0.7.0](https://github.com/evert/hal-browser/blob/master/screenshots/0.7.0-csv.png)
+![Screenshot from 0.9.1](https://github.com/evert/hal-browser/blob/master/screenshots/0.9.1-csv.png)
 
 The following example converts this:
 
@@ -117,7 +119,7 @@ The following example converts this:
 
 And automatically turns the templated link into a form:
 
-![Screenshot from 0.7.0](https://github.com/evert/hal-browser/blob/master/screenshots/0.7.0-form.png)
+![Screenshot from 0.9.1](https://github.com/evert/hal-browser/blob/master/screenshots/0.9.1-form.png)
 
 
 Supported frameworks

assets/themes/curveball/main.css

@@ -156,11 +156,7 @@ nav li a img {
 nav .alternate {
   display: flex;
   align-items: center;
-  padding-left: 30px;
-}
-
-nav .alternate a {
-  min-width: 1px;
+  padding-left: 30px
 }
 
 nav .alternate h3 {
@@ -169,6 +165,8 @@ nav .alternate h3 {
   font-size: 16px;
 }
 nav .alternate a {
+  min-width: 1px;
+  margin-left: 3px;
   font-size: 90%;
   background: #555;
   display: inline-block;

package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "hal-browser",
+  "name": "@curveball/browser",
   "version": "0.9.1",
-  "description": "A HAL browser middleware",
+  "description": "Automatic API browser generator. A middleware that turns your JSON responses into HTML if accessed by a browser.",
   "main": "dist/index.js",
   "scripts": {
     "prepublishOnly": "make build",
@@ -10,7 +10,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/evert/hal-browser"
+    "url": "git+https://github.com/evert/browser"
   },
   "files": [
     "README.md",
@@ -31,9 +31,9 @@
   "author": "Evert Pot (https://evertpot.com/)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/evert/hal-browser"
+    "url": "https://github.com/evert/browser"
   },
-  "homepage": "https://github.com/evert/hal-browser#readme",
+  "homepage": "https://github.com/evert/browser#readme",
   "devDependencies": {
     "@curveball/core": "^0.14.2",
     "@types/chai": "^4.2.12",
@@ -51,7 +51,8 @@
     "nyc": "^15.1.0",
     "sinon": "^9.0.3",
     "ts-node": "^9.0.0",
-    "typescript": "^4.0.3"
+    "typescript": "^4.0.3",
+    "@types/react-dom": "^16.9.8"
   },
   "types": "dist/",
   "nyc": {
@@ -60,7 +61,6 @@
     ]
   },
   "dependencies": {
-    "@types/react-dom": "^16.9.8",
     "csv-parse": "^4.12.0",
     "highlight.js": "^10.2.0",
     "ketting": "^6.0.2",