https://github.com/tleonhardt/todd_palindrome
Repo for me learning how to publish a Ruby gem
https://github.com/tleonhardt/todd_palindrome
Last synced: 6 months ago
JSON representation
Repo for me learning how to publish a Ruby gem
- Host: GitHub
- URL: https://github.com/tleonhardt/todd_palindrome
- Owner: tleonhardt
- License: mit
- Created: 2020-02-28T01:37:20.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-28T20:27:43.000Z (about 6 years ago)
- Last Synced: 2024-04-24T15:26:58.438Z (about 2 years ago)
- Language: Ruby
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ToddPalindrome
`todd_palindrome` is a sample Ruby gem created in [*Learn Enough Ruby to Be Dangerous*](https://www.learnenough.com/ruby-tutorial) by Michael Hartl.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'todd_palindrome'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install todd_palindrome
## Usage
`todd_palindrome` adds a `palindrome?` method to the `String` class, and can be used as follows:
```
$ irb
>> require 'todd_palindrome'
>> "honey badger".palindrome?
=> false
>> "deified".palindrome?
=> true
>> "Able was I, ere I saw Elba.".palindrome?
=> true
>> phrase = "Madam, I'm Adam."
>> phrase.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.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tleonhardt/todd_palindrome.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).