Skip to content

Commit fb166b6

Browse files
committed
Change README filename to be recognized as markdown by github
1 parent 8f0782e commit fb166b6

1 file changed

Lines changed: 20 additions & 18 deletions

File tree

README renamed to README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,42 +23,44 @@ How To Use It
2323
-------------
2424

2525
In its simplest form:
26-
27-
`ID3.loadTags("filename.mp3", function() {
26+
```
27+
ID3.loadTags("filename.mp3", function() {
2828
var tags = ID3.getAllTags(filename);
2929
alert(tags.artist + " - " + tags.title + ", " + tags.album);
30-
});`
30+
});
31+
```
3132

3233
by specifying specific tags:
33-
34-
`ID3.loadTags("filename.mp3", function() {
34+
```
35+
ID3.loadTags("filename.mp3", function() {
3536
var tags = ID3.getAllTags(filename);
3637
alert(tags.COMM.data + " - " + tags.TCON.data + ", " + tags.WXXX.data);
3738
},
38-
{tags: ["COMM", "TCON", "WXXX"]});`
39+
{tags: ["COMM", "TCON", "WXXX"]});
40+
```
3941

4042
or even by specifying shortcuts instead of cryptic tags:
41-
42-
`ID3.loadTags("filename.mp3", function() {
43+
```
44+
ID3.loadTags("filename.mp3", function() {
4345
var tags = ID3.getAllTags(filename);
4446
alert(tags.comment + " - " + tags.track + ", " + tags.lyrics);
4547
},
46-
{tags: ["comment", "track", "lyrics"]});`
47-
48+
{tags: ["comment", "track", "lyrics"]});
49+
```
4850
Documentation
4951
-------------
5052

51-
`ID3.loadTags(url, cb, [options])`
52-
`url` - The URL of the mp3 file to read, this must reside on the same domain (document.domain).
53-
`cb` - The callback function to invoke when the tags are loaded.
53+
`ID3.loadTags(url, cb, [options])`
54+
`url` - The URL of the mp3 file to read, this must reside on the same domain (document.domain).
55+
`cb` - The callback function to invoke when the tags are loaded.
5456
`options` - Optional parameters.
5557
`options.tags` - The array of tags and/or shortcuts to read from the ID3 block. Default value is: `["title", "artist", "album", "track"]`
5658
`options.dataReader` - The function used to create the data reader out of a url. It receives (`url`, `success`: callback function that returns the data reader, `fail`: callback function to inform an error setting up the reader). By default it will be BufferedBinaryAjax.
57-
58-
`ID3.getAllTags(url)`
59-
`url` - The URL of the mp3 file to read, this must be the same value given to `ID3.loadTags()`.
59+
60+
`ID3.getAllTags(url)`
61+
`url` - The URL of the mp3 file to read, this must be the same value given to `ID3.loadTags()`.
6062
`return value` - This function will return the following object structure, for IDv1:
61-
63+
6264
{
6365
version: "1.1",
6466
title: string,
@@ -68,7 +70,7 @@ Documentation
6870
comment: string,
6971
track: string,
7072
genre: string
71-
}
73+
}
7274
for ID3v2:
7375

7476
{

0 commit comments

Comments
 (0)