Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
eregon committed Dec 12, 2023
1 parent bf8d23e commit 3393249
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
debug_inspector
===============

_A Ruby wrapper for the MRI 2.0+ debug\_inspector API_
_A Ruby wrapper for the Ruby 2.0+ debug_inspector C API_

The `debug_inspector` C extension and API were designed and built by [Koichi Sasada](https://github.com/ko1), this project
is just a gemification of his work.

**NOTES:**

* **Do not use this library outside of debugging situations**.
* This library makes use of the debug inspector API which was new in MRI 2.0.0.
* Only works on MRI 2 and 3. Requiring it on unsupported Rubies will result in a no-op
* This library makes use of the debug inspector API which was new in CRuby 2.0.0.
* Only works on CRuby 2+ and TruffleRuby. Requiring it on unsupported Rubies will result in a no-op.

Usage
-----
Expand Down Expand Up @@ -46,7 +46,8 @@ 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).
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 in `debug_inspector.gemspec`, 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).

Contact
-------
Expand Down

0 comments on commit 3393249

Please sign in to comment.