rex-text/README.md

# Rex::Text

This is the Ruby Exploitation(rex) library for text generation and manipulation. It provides many different options for generating randomzied text or altering existing text. It is based entirely off of
the work originally created inside Metasploit Framework itself.


## Installation

Add this line to your application's Gemfile:

```ruby
gem 'rex-text'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install rex-text

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rapid7/rex-text. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct found in CODE_OF_CONDUCT.md.