README.md in meroku-2.0.22 vs README.md in meroku-2.0.23

- old
+ new

@@ -1,108 +1,48 @@ +Meroku +====== +because hosting 100 apps costs $700 ($7x100) at you-know-where.com -[![Build Status](https://travis-ci.org/meroku/meroku.svg?branch=master)](https://travis-ci.org/meroku/meroku) -[![Test Coverage](https://api.codeclimate.com/v1/badges/cfec7757799809e85194/test_coverage)](https://codeclimate.com/github/meroku/meroku/test_coverage) -[![Maintainability](https://api.codeclimate.com/v1/badges/cfec7757799809e85194/maintainability)](https://codeclimate.com/github/meroku/meroku/maintainability) -[![Dependency Status](https://gemnasium.com/badges/github.com/meroku/meroku.svg)](https://gemnasium.com/github.com/meroku/meroku) +[![Quality](https://img.shields.io/codeclimate/github/meroku/meroku.svg?style=flat-square)](https://codeclimate.com/github/meroku/meroku) +[![Coverage](https://img.shields.io/codeclimate/coverage/github/meroku/meroku.svg?style=flat-square)](https://codeclimate.com/github/meroku/meroku) +[![Build](https://img.shields.io/travis-ci/meroku/meroku.svg?style=flat-square)](https://travis-ci.org/meroku/meroku) +[![Dependencies](https://img.shields.io/gemnasium/meroku/meroku.svg?style=flat-square)](https://gemnasium.com/meroku/meroku) +[![Downloads](https://img.shields.io/gem/meroku/meroku.svg?style=flat-square)](https://rubygems.org/gems/meroku) +[![Issues](https://img.shields.io/github/issues/meroku/meroku.svg?style=flat-square)](https://github.com/meroku/meroku/issues) +[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](http://opensource.org/licenses/MIT) [![Gem Version](https://badge.fury.io/rb/meroku.svg)](https://badge.fury.io/rb/meroku) -[![Gratipay](https://img.shields.io/gratipay/user/meroku.svg)](https://gratipay.com/meroku/) +[![Donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/meroku/donate) -## My Heroku (Meroku), because hosting 100 apps costs $700 ($7x100) at heroku.com -Ruby on Rails is a popular web framework written in Ruby. This guide covers using Rails 5 on Meroku. To follow along, you need +## Installation -- Basic Ruby/Rails knowledge. -- A locally installed version of Ruby 2.4.2+, Rubygems, Bundler, and Rails 5+. -- Basic Git knowledge. +Make sure you have the latest stable ruby installed +```bash +ruby --version +``` -Install the meroku gem on your local workstation +And then execute: $ gem install meroku -Once installed, you’ll have access to the `$ meroku` command from your command shell. +## Usage - $ meroku signup # if you haven't done already + $ meroku --help -Make sure you're running the latest version of ruby +## Development - $ cd ~; ruby --version - ruby 2.4.2p198 (2017-09-14 revision 59899) [x86_64-darwin16] +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. -Install the rails gem if you haven't done already +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). - $ gem install rails --no-ri --no-rdoc - Successfully installed rails-5.1.4 - 1 gem installed + $ ./guard # keeps an eye on test fails and rubocop warnings -Then create a new app: +## Contributing - $ rails new myapp --database=postgresql +Bug reports and pull requests are welcome on GitHub at https://github.com/meroku/meroku. -Then move into your application directory. +## License - $ cd myapp - -Mention you want to the latest ruby version - - $ echo "2.4.2" > .ruby-version - -And commit it - - $ git add --all; git commit -m "Added ruby version"; - -Register your application with meroku - - $ meroku create - Creating app... done - -Add your public key to meroku - - $ meroku keys:add - -And deploy - - $ git push meroku master - $ meroku run rake db:migrate - - - -## DOCUMENTATION FOR MAINTAINERS - - -### Secrets - -The meroku secret is a 12 charactor hex string, eg. 'dcb528615aa4' -All other secrets are derived/downloaded from it. -To do administrative commands such as spawn, despawn, you would need to -do this first, - - export SECRET="example" - - -### Commands - - $ meroku infrastructure spawn - $ meroku infrastructure despawn - - $ rubocop -D -F --except FrozenStringLiteralComment,StringLiterals,MutableConstant lib/ - Inspecting 15 files - ............... - - 15 files inspected, no offenses detected - $ - -### TODO - - - Only latest stable ruby is supported at the moment - - Only latest stable rails is supported at the moment - - Only RAILS_ENV=procution is supported at the moment - - Only puma is supported at the moment - -### To Run tests - - rake - - - +The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).