README.md 1.53 KB
Newer Older
dosse91's avatar
dosse91 committed
1
# HTML5 Speedtest
dosse91's avatar
dosse91 committed
2 3 4

No Flash, No Java, No Websocket, No Bullshit.

dosse91's avatar
dosse91 committed
5
This is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers.
dosse91's avatar
dosse91 committed
6 7

## Try it
dosse91's avatar
dosse91 committed
8
[Take a Speedtest](http://speedtest.fdossena.com)
dosse91's avatar
dosse91 committed
9 10

## Compatibility
dosse91's avatar
dosse91 committed
11
Only modern browsers are supported (Edge 12+)
dosse91's avatar
dosse91 committed
12 13

## Requirements
dosse91's avatar
dosse91 committed
14
 - A reasonably fast web server
dosse91's avatar
dosse91 committed
15
 - Some way to generate garbage data using either the included PHP script, a [big file of random data](http://downloads.fdossena.com/geth.php?r=speedtest-bigfile), or a symlink to /dev/urandom
dosse91's avatar
dosse91 committed
16 17
 - Your server must accept large POST requests (up to 10 Megabytes), otherwise the upload test will fail
 - Client side, there must not be any type of buffering (such as a proxy), or you may get incorrect results
dosse91's avatar
dosse91 committed
18
 - It's also better if your server does not use compression, but it's not mandatory
dosse91's avatar
dosse91 committed
19 20

## How to use
dosse91's avatar
dosse91 committed
21
See the examples, it's really simple.
dosse91's avatar
dosse91 committed
22 23

## License
dosse91's avatar
dosse91 committed
24
Copyright (C) 2016-2017 Federico Dossena
dosse91's avatar
dosse91 committed
25 26 27 28 29 30 31 32 33 34 35 36 37

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/lgpl>.