README.md in hsztan_palindrome-0.2.0 vs README.md in hsztan_palindrome-0.2.1
- old
+ new
@@ -1,10 +1,10 @@
# HsztanPalindrome
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hsztan_palindrome`. To experiment with that code, run `bin/console` for an interactive prompt.
+To experiment with that code, run `bin/console` for an interactive prompt.
-This gem is a palindrome detector for strings. It can be used as a library or as a command line tool.
+This gem is a palindrome detector for strings and integers. It can be used as a library or as a command line tool.
## Installation
Add this line to your application's Gemfile:
@@ -20,12 +20,26 @@
$ gem install hsztan_palindrome
## Usage
-TODO: Use as a library:
+Use as a library:
-```ruby
+```
+
+require 'hsztan_palindrome'
+```
+
+```
+"foo".palindrome? # => false
+
+"racecar".palindrome? # => true
+
+12345.palindrome? # => false
+
+12321.palindrome? # => true
+
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.