accessproxy - npm Package Compare versions

Comparing version 0.3.4 to 0.3.5

docs/index.md

@@ -1,2 +0,2 @@
-## Options
+## [Options](/usage/#options)
 
@@ -3,0 +3,0 @@ * `accessproxy -h, --help` - Output usage information.

docs/usage.md

 ## Options
 
+* `accessproxy -h, --help` - Output usage information.
+* `accessproxy -V, --version` - Output the version number.
+* `accessproxy -l, --listen <n>` - The port to listen on.
+* `accessproxy -t, --target <n>` - The port to loopback to.
+* `accessproxy -T, --hostname <hostname>` - The hostname to loopback to.
+* `accessproxy -p, --proxy <hostname>` - The hostname to proxy to.
+* `accessproxy -v, --verbose` - Enable verbose logging.
+* `accessproxy -m, --mode <mode>` - Proxy mode (labs, portal, or mixed).
+* `accessproxy -s, --static <path>` - Path to serve up static assets.
+
 ## Commands
 
+* `accessproxy [options]` - The default command starts the proxy with the provided options.
+* `accessproxy configure` - The configure command invokes configuration process.
+
 ## Configuration
+
+Invoke configuration with `accessproxy configure`.
+
+Configure will ask you for your preferred hosts.  
+The defaults (`foo.redhat.com` & `prod.foo.redhat.com` will be used if configuration is not run)

package.json

 {
   "name": "accessproxy",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "main": "index.js",
@@ -5,0 +5,0 @@ "description": "A proxy for local access labs development",

README.md

@@ -10,13 +10,9 @@ accessproxy
 
-This line must be in your /etc/hosts file for this proxy to work properly:
-`127.0.0.1 foo.redhat.com prod.foo.redhat.com`
-
-the module has a helper that will assist with this and can be run with
+Configure the module with:
 ```bash
-npm run -g accessproxy hosts --unsafe
+accessproxy configure
 ```
 
-_Note about the `--unsafe`_: This allows the npm script to run as YOUR user... by default npm runs scripts as 'nobody'. This will just execute the [hosts.sh](hosts.sh) script. Feel free to browse that script if you don't trust me. :smirk:
+[Read the docs.](https://redhataccess.github.io/accessproxy/)
 
-On first run you will be prompted to enter a ci server location. Enter this **without** the protocol i.e. `the.ci.server.com`
 
@@ -23,0 +19,0 @@ ## License

No alert changes

Improved metrics

Total package byte prevSize

23345

increased by1.28%

Worsened metrics

Number of package files

27

decreased by-3.57%

Number of lines in readme file

22

decreased by-15.38%

No dependency changes