README.md in memory_profiler-0.9.14 vs README.md in memory_profiler-1.0.0

- old
+ new

@@ -1,15 +1,15 @@ -[![Build Status](https://travis-ci.org/SamSaffron/memory_profiler.svg?branch=master)](https://travis-ci.org/SamSaffron/memory_profiler) +[![CI](https://github.com/SamSaffron/memory_profiler/workflows/CI/badge.svg)](https://github.com/SamSaffron/memory_profiler/actions?query=workflow%3ACI) [![Gem Version](https://badge.fury.io/rb/memory_profiler.svg)](https://rubygems.org/gems/memory_profiler) # MemoryProfiler A memory profiler for Ruby ## Requirements -Ruby(MRI) Version 2.3.8 and above. +Ruby(MRI) Version 2.5.0 and above. ## Installation Add this line to your application's Gemfile: @@ -22,9 +22,28 @@ Or install it yourself as: $ gem install memory_profiler ## Usage + +There are two ways to use `memory_profiler`: +* command line +* convenience API + +### Command Line + +The easiest way to use memory_profiler is via the command line, which requires no modifications to your program. The basic usage is: +``` +$ ruby-memory-profiler [options] <script.rb> [--] [script-options] +``` +Where `script.rb` is the program you want to profile. + +For a full list of options, execute the following command: +``` +ruby-memory-profiler -h +``` + +### Convenience API ```ruby require 'memory_profiler' report = MemoryProfiler.report do # run your code here