NewsReader

News Reader is a CLI app that allows you to list and read a list of articles scraped from a website on the internet. It's also available as a ruby gem.

This project is for education purpose only. Do not use it in production. I built it as a homework of the Full Stack Web Developer curriculum I'm following at Flatiron School.

Installation

Add this line to your application's Gemfile:

gem 'news_reader'

And then execute:

$ bundle

Or install it yourself as:

$ gem install news_reader

Usage

To use the gem you have to require it in your project like so:

Go to your projects folder
Create a folder to try the gem mkdir -p /your/project/folder/news-reader & cd into it
In your terminal type echo "gem 'news_reader'" > Gemfile
Then type bundle install --path vendor
Create ruby test file with touch test.rb

Add this code in your ruby file:

require "bundler/setup"
require 'news_reader'

NewsReader::CLI.start

Now run the program with ruby test.rb
Have fun!

Development

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jgb-solutions/news-reader-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct