Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,29 @@ How to use from other programs
==============================

* Include `id3_tags` in the Gemfile of your bundled project and `bundle install`
* To read metadata from a file, run `Id3Tags.read_from_file(file_path)`
* To write metadata to a file, run `Id3Tags.write_to_file(file_path, metadata)`
* To read metadata from a file, run `Id3Tags.read_tags_from(file_path)`
* To write metadata to a file, run `Id3Tags.write_tags_to(file_path, metadata)`

Here is a small example:

```
#!/usr/bin/env ruby
require 'id3_tags'

file_path = "/tmp/song.mp3"
image_path = "/tmp/cover.jpg"

tags = Id3Tags.read_tags_from(file_path)
tags[:artist] = "ACDC"
tags[:title] = "Hells Bells"
tags[:track][:number] = 1
tags[:track][:count] = 10
tags[:album] = "Back in Black"
tags[:cover_art][:mime_type] = "image/jpeg"
tags[:cover_art][:data] = File.read(image_path)

Id3Tags.write_tags_to(file_path, tags)
```

For more details about the format of the metadata, check the [specs](http://github.com/topspin/id3_tags/tree/master/spec/lib) or the [documentation at RubyDoc.info](http://rubydoc.info/github/topspin/id3_tags/frames).

Expand All @@ -45,4 +66,4 @@ Make sure tests pass, then either submit a Pull Request.
Please consider testing against the [versions of Ruby supported](https://travis-ci.org/topspin/id3_tags) by ID3 Tags.

A list of [nice TODOs](http://github.com/topspin/id3_tags/tree/master/TODO.md) is provided.
You can also build a new version of the gem and move it to your gem repository.
You can also build a new version of the gem and move it to your gem repository.