# fpsdisplay
> A simple frames per second display.
Latest version **0.1.3** (published 2014-09-07) · MIT license · 0 weekly downloads
## Install
```sh
npm install fpsdisplay
pnpm add fpsdisplay
yarn add fpsdisplay
bun add fpsdisplay
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 0.1.3 |
| Published | 2014-09-07 |
| First published | 2014-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vince Allen |
| Maintainers | vinceallenvince |
| Keywords | utilities |
## Links
- npm: https://www.npmjs.com/package/fpsdisplay
- Repository: http://github.com/vinceallenvince/fpsdisplay
- Issues: https://github.com/vinceallenvince/fpsdisplay/issues
- npm.io page: https://npm.io/package/fpsdisplay
## Recent versions
- 0.1.3 (latest) — 2014-09-07
- 0.1.2 — 2014-09-02
- 0.1.1 — 2014-09-01
- 0.1.0 — 2014-08-31
## README
# fpsdisplay
A simple frames per second display.
##Install
To include fpsdisplay as a component in your project, use the node module.
```
npm install fpsdisplay --save
```
You can also use the [standalone version](https://github.com/vinceallenvince/fpsdisplay/releases/latest) and reference the js file from your document.
```
...
```
##Usage
The module exports a FPSDisplay class. In a nodejs project, you access it via:
```
var FPSDisplay = require('../src/fpsdisplay');
```
In the browser, the module exposes an FPSDisplay class. Call init() to render the display. Call FPSDisplay.update from an animation loop to track the frames per second.
```