Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
deprecated
  • Loading branch information
turuslan authored Aug 27, 2018
1 parent 15e37fb commit dbb2113
Showing 1 changed file with 10 additions and 43 deletions.
53 changes: 10 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,11 @@
# HackTimer
Avoid timers throttling by browser when tab is inactive

# Usage:
Place script reference to **HackTimer.js** (or HackTimer.min.js) before any other JavaScript.
This includes library's such as jQuery as otherwise timed events such as fadeOut and fadeIn will break.

# NPM
Command: `npm install hacktimer --reg https://www.myget.org/F/hack-timer/npm`

Latest version is 1.1.0

Registry URL: https://www.myget.org/F/hack-timer/npm

# Bower
Command: `bower install hacktimer`

Latest version is 1.1.0

Registry: https://www.myget.org/F/hack-timer/bower/

You can specify bower registry in file `.bowerrc` in your working directory
```json
{
"registry": {
"search": [
"https://www.myget.org/F/hack-timer/bower/",
"https://bower.herokuapp.com"
]
}
}
# Deprecated
## Use [chrisguttandin/worker-timers](https://github.com/chrisguttandin/worker-timers) instead
Use monkey-patching to replace default `window.setInterval`, `window.clearInterval`, `window.setTimeout`, `window.clearTimeout`.

```js
import * as workerTimers from 'worker-timers';
window.setInterval = workerTimers.setInterval;
window.clearInterval = workerTimers.clearInterval;
window.setTimeout = workerTimers.setTimeout;
window.clearTimeout = workerTimers.clearTimeout;
```

# Notes
Loader code **HackTimer.js** (or HackTimer.min.js) may be placed in separate file or in script tag.

Worker code **HackTimerWorker.js** (or HackTimerWorker.min.js) must be placed in separate file. It is used to fallback if Blob is not supported

To **change** worker code **script name** or path go to the end of **HackTimer.js** (or HackTimer.min.js) file and replace script name.

**HackTimer.silent.min.js** writes to log only if initialisation failed. Use it with **HackTimerWorker.min.js** .

# Warning
Full code (HackTimer.js and HackTimerWorker.js) must not be used with minified (HackTimer.min.js and HackTimerWorker.min.js), i.e. **HackTimer.js** must use **only HackTimerWorker.js** and **HackTimer.min.js** must use **only HackTimerWorker.min.js** .

0 comments on commit dbb2113

Please sign in to comment.