Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.33 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.33 KB
Raw

alt text

Foxynews

Build Status Gem Code Climate Coverage

Description

This is a Rails wrapper to the PR.co API, which pulls in your PR.co content and lets you display it completely on your own website. This lets you keep the SEO juice that comes from your press releases and have more control over styling.

As a namespaced Rails engine, +foxynews+ can be easily overwritten to suit your individual needs.

Installation

If you are using bundler, add this line to your Gemfile:

gem 'foxynews', git: '[email protected]:HitFox/foxynews.git'

And install your gem:

$ bundle install

If you are not using bundler just type:

$ gem install foxynews

After you have installed the gem, generate the intialzer:

$ rails g foxynews:initializer

Browse to the generated initializer. You should found it in config/initializers/foxynews.rb. Change here +YOUR_PR_CO_ID_HERE+ to your PR.co pressroom ID.

Now you have to mount the engine in your routes file.

mount Foxynews::Engine => '/pr', as: 'foxynews'

Usage

By default a pressroom in your app is accessible at +/pr/pressrooms+.

Other routes are:

  • pr/pressrooms/show/:id

  • pr/pressrooms/archive

  • pr/presskit/show/:id

Archives display older articles, presskits display individual PR.co presskits.

Changelog

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/HitFox/foxynews. 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.