<<<<<<< HEAD

shodany

Ruby library for interacting with the Shodan API

---

Shodany

Shodany is a versatile Ruby library for interacting with the Shodan API. It simplifies the process of searching for internet-connected devices, retrieving specific IP information, exploring vulnerabilities, and more.

Table of Contents

• Installation
• Usage
  • Setting Up
  • Retrieving Host Information
  • Searching for Vulnerabilities
  • General Shodan Search
  • Listing All Ports
  • Requesting a Shodan Scan
  • Getting Domain Information
• Examples
• Development
• Contributing
• License
• Code of Conduct

Installation

Add this line to your application's Gemfile:

gem 'shodany'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install shodany

Usage

Setting Up

require 'shodany'

client = Shodany.new("YOUR_SHODAN_API_KEY")

[Other Usage Instructions]

Examples

Refer to the examples directory for detailed examples of using Shodany in various scenarios.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Abo5/shodany. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Shodany project's codebase, issue trackers, chat rooms, and mailing lists is expected to follow the code of conduct.

---

c3d5001 (Initial Commit)

shodany