README.md in iconv-1.0.4 vs README.md in iconv-1.0.5
- old
+ new
@@ -1,8 +1,8 @@
# Iconv
-[](https://travis-ci.org/nurse/iconv)
+[](https://travis-ci.org/ruby/iconv)
iconv wrapper, used to be ext/iconv
## Abstract
@@ -19,11 +19,13 @@
## Installation
Add this line to your application's Gemfile:
- gem 'iconv'
+```ruby
+gem 'iconv'
+```
And then execute:
$ bundle
@@ -32,38 +34,39 @@
$ gem install iconv
## Usage
1. Simple conversion between two charsets.
-
- converted_text = Iconv.conv('iso-8859-15', 'utf-8', text)
-
-2. Instantiate a new Iconv and use method Iconv#iconv.
-
+ ```ruby
+ converted_text = Iconv.conv('iso-8859-15', 'utf-8', text)
+ ```
+2. Instantiate a new `Iconv` and use method `Iconv#iconv`.
+ ```ruby
cd = Iconv.new(to, from)
begin
input.each { |s| output << cd.iconv(s) }
output << cd.iconv(nil) # Don't forget this!
ensure
cd.close
end
-
-3. Invoke Iconv.open with a block.
-
+ ```
+3. Invoke `Iconv.open` with a block.
+ ```ruby
Iconv.open(to, from) do |cd|
input.each { |s| output << cd.iconv(s) }
output << cd.iconv(nil)
end
-
+ ```
4. Shorthand for (3).
-
+ ```ruby
Iconv.iconv(to, from, *input.to_a)
+ ```
## Attentions
-Even if some extentions of implementation dependent are useful,
-DON'T USE those extentions in libraries and scripts to widely distribute.
-If you want to use those feature, use String#encode.
+Even if some extensions of implementation dependent are useful,
+DON'T USE those extensions in libraries and scripts to widely distribute.
+If you want to use those feature, use `String#encode`.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)