Skip to content

Commit

Permalink
Update license / git repository / .min / usage notes
Browse files Browse the repository at this point in the history
  • Loading branch information
pastcompute committed May 4, 2018
1 parent 884d4db commit df9571a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
9 changes: 4 additions & 5 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,16 @@ Briefly paraphrased, you can use Teuthis in a commercial setting, and the MPL do

The easiest way to make available is to submit a pull request :-)

I'm also happy to dual-license, so contact me to negotiate a commercial license if required.
Please contact Platfarm to negotiate a commercial license if compliance with the MPL 2.0 license is does not fit your use case.

# Usage example

1. Load teuthis:

```
...
<script src="path/to/teuthis.js"></script>
...
```

2. Shim XMLHttpRequest:

```
Expand Down Expand Up @@ -78,12 +76,13 @@ Teuthis works by monkey-patching the native `XMLHttpRequest` class. As such it g
* Teuthis may break various test harnesses such as `sinon` which themselves mock an XHR server
* There needs to be a proper test harness using mocha or similar
* RequestCache.onready wont fire as it cant be set until after when default created by Teuthis
* There should be a `.min.js` build
* Did I say it needed a unit test suite? Assistance gratefully received :-)
* Teuthis may need to be started between vendor and main in an Ionic application, to avoid some conflicts observed with other libraries such as Firebase.
* Create a .min.js version - presently the dist/teuthis.js file has been processed with Babel for cross browser compatibility but has not been shrunk.

# Developing

Run `npm install` then `npm run bundle` to create `teuthis.js`
Run `npm install` then `npm run bundle` to create `dist/teuthis.js`

# Etymology

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "teuthis",
"version": "0.1.0",
"version": "0.1.1",
"description": "An XHR intercepting transparent proxy cache",
"keywords": [
"xhr",
Expand All @@ -9,7 +9,7 @@
],
"repository": {
"type": "git",
"url": "https://github.com/pastcompute/teuthis.git"
"url": "https://github.com/platfarm-com/teuthis.git"
},
"main": "lib/index.js",
"module": "teuthis.js",
Expand Down

0 comments on commit df9571a

Please sign in to comment.