cache-companion 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -0
- package/package.json +5 -1
package/README.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# About
|
|
2
|
+
|
|
3
|
+
Cache-companion is a cli tool built using node.js that allows users to run a caching proxy server. cache-companion runs on a port specified by the user, and listens for requests being made to a resource/origin. The origin is also specified by the user. The cache proxy saves responses from the origin so that accessing that same resource in the near future is more efficient.
|
|
4
|
+
|
|
5
|
+
# Usage
|
|
6
|
+
|
|
7
|
+
To start a caching proxy server, run the following command:
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
cache-companion --port <your_port> --origin <link_to_resource>
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
if you do not pass arguments in the terminal, the tool will look for a config file that contains the port and origin fields in the current working directory.
|
|
15
|
+
|
|
16
|
+
# Installation
|
|
17
|
+
|
|
18
|
+
- run `npm i cache-companion` in the terminal
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cache-companion",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
@@ -107,6 +107,10 @@
|
|
|
107
107
|
"scripts": {
|
|
108
108
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
109
109
|
},
|
|
110
|
+
"repository": {
|
|
111
|
+
"type": "git",
|
|
112
|
+
"url": "git+https://github.com/kenan456/cache-companion.git"
|
|
113
|
+
},
|
|
110
114
|
"keywords": [],
|
|
111
115
|
"author": "",
|
|
112
116
|
"license": "ISC",
|