Skip to content

Commit d68c555

Browse files
committed
Updating README
Updating README Updating README Updating README
1 parent 984404d commit d68c555

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

README.md

+13-17
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ filesize.js provides a simple way to get a human readable file size string from
77

88
`filesize()` accepts an optional descriptor Object as a second argument, so you can customize the output.
99

10-
#### bits
11-
Enables `bit` sizes, default is `false`
10+
### bits
11+
_***(boolean)***_ Enables `bit` sizes, default is `false`
1212

13-
#### unix
14-
Enables unix style human readable output, e.g `ls -lh`, default is `false`
13+
### unix
14+
_***(boolean)***_ Enables unix style human readable output, e.g `ls -lh`, default is `false`
1515

16-
#### base
17-
Number base, default is `10`
16+
### base
17+
_***(number)***_ Number base, default is `10`
1818

19-
#### round
20-
Decimal place, default is `2`
19+
### round
20+
_***(number)***_ Decimal place, default is `2`
2121

22-
#### spacer
23-
Character between the `result` and `suffix`, default is `" "`
22+
### spacer
23+
_***(string)***_ Character between the `result` and `suffix`, default is `" "`
2424

2525
## Examples
2626

@@ -38,14 +38,10 @@ filesize.js supports AMD loaders (require.js, curl.js, etc.), node.js & npm (npm
3838

3939
## Support
4040

41-
If you're having problems with using the project, use the support forum at CodersClan.
41+
If you're having problems, use the support forum at CodersClan.
4242

4343
<a href="http://codersclan.net/forum/index.php?repo_id=11"><img src="http://www.codersclan.net/graphics/getSupport_blue_big.png" width="160"></a>
4444

4545
## License
46-
47-
filesize.js is licensed under BSD-3 https://raw.github.com/avoidwork/filesize.js/master/LICENSE
48-
49-
## Copyright
50-
51-
Copyright (c) 2013, Jason Mulligan <[email protected]>
46+
Copyright (c) 2013 Jason Mulligan
47+
Licensed under the BSD-3 license.

0 commit comments

Comments
 (0)