Skip to content

Commit 2b28015

Browse files
Update README.md
Updated TODO
1 parent 382b94e commit 2b28015

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
11
# jquery-speedtest-plugin
22
This is a plugin created in Jquery to display the speed in the network. A file from the user specified location is taked and it is used to measure the bandwidth between the server and the user sytem.
3+
4+
<pre>
5+
The plugin takes inputs like:
6+
- fileSize
7+
- fileType
8+
- fileUrl
9+
- error message
10+
- waiting message
11+
</pre>
12+
<h2>Description of arguments</h2>
13+
<ol>
14+
<li>
15+
<h3>filesize</h3>
16+
<p>Takes the size of the reference file in bytes. This will be the maximum size of the file That will be downloaded from the server</p>
17+
<p>
18+
The file will be downloaded and the time taken to download this file is returned as the bandwidth speed.
19+
</p>
20+
</li>
21+
<li>
22+
<h3>fileType</h3>
23+
<p>The file type is the extension of the file that is to be downloaded to calculate the Bandwidth speed.</p>
24+
<b>Currently handling documents and image formats.</b>
25+
</li>
26+
<li>
27+
<h3>fileUrl</h3>
28+
<p>This takes the url of the file location.</p>
29+
<b>Currently handling complete URL without validation</b>
30+
</li>
31+
<li>
32+
<h3>error Message</h3>
33+
<p>The message that needs to be displayed when the file fails to download</p>
34+
<p>
35+
This will replace all text inside the calling DOM element with the error message.
36+
</p>
37+
</li>
38+
<li>
39+
<h3>Waiting Message</h3>
40+
<p>The message that needs to be displayed when the user waits to for the file to download and the operations to complete</p>
41+
</li>
42+
43+
</ol>
44+
<h2>TODO</h2>
45+
<p>Create a fallback for all the arguments in case the user is not able to provide them in the call.</p>
46+
<p>Create a function to handle upload speed check.</p>

0 commit comments

Comments
 (0)