Sha256: 07e4eee2495ff9c3119be384f768b93794ed4c5bc543c23f58869c0d186a9492

Contents?: true

Size: 1.67 KB

Versions: 1

Compression:

Stored size: 1.67 KB

Contents

# Ammitto

Retrieve sanctioned people and organizations from various reputed published sources
## Installation

Add this line to your application's Gemfile:

```ruby
gem 'ammitto'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install ammitto

## Usage

```ruby
Ammitto::search(SEARCH_TERM) # e.g. Ammitto::search('Salih')
```
will respond with a `Ammitto::SanctionItemCollection` object, which contains a collection of `Ammitto::SanctionItem`

## 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 the created tag, 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/ammitto/ammitto. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ammitto/ammitto/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Ammitto project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ammitto/ammitto/blob/master/CODE_OF_CONDUCT.md).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
ammitto-0.1.0 README.md