nomius 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 308bde52bb6827228b328640da6422ae263c06df4c60b5d08e84dd00383243bb
+  data.tar.gz: b810b61fc6c73882c5d91f0deae8128ce1cfc895e67710e31295226a0d04b052
+SHA512:
+  metadata.gz: 0c7ea9f1d3c24221d19a258ce57889617adef1f1358faf7e3f08f5f370ad9d6a26dabcbeab52a9fe35d67a0e88de18a14737951efd8197992f60dd670f1442f0
+  data.tar.gz: 36542e45dcea9c89aebce4de4d4eedee7b76e50430ba8df4cf8010206917d395d3131657bfd639e3e39dc5764dc09ba406ba4cfd954abcb50318c5a41b63fc52

data/.dockerignore

@@ -0,0 +1,5 @@
+.bundle/*
+.idea*
+log/*
+tmp/*
+.ruby-lsp/*

data/.editorconfig

@@ -0,0 +1,12 @@
+# Defines the coding style for different editors and IDEs.
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/.overcommit.yml

@@ -0,0 +1,29 @@
+PreCommit:
+  ALL:
+    on_warn: fail
+  BundleCheck:
+    enabled: true
+  FileSize:
+    enabled: true
+    size_limit_bytes: 1_000_000
+  ForbiddenBranches:
+    enabled: true
+  LineEndings:
+    enabled: true
+  RuboCop:
+    enabled: true
+  TrailingWhitespace:
+    enabled: true
+  YamlSyntax:
+    enabled: true
+
+CommitMsg:
+  ALL:
+    on_warn: fail
+  # Disable some default Overcommit checks to avoid collisions with commitlint.
+  TextWidth:
+    enabled: false
+  CapitalizedSubject:
+    enabled: false
+  SingleLineSubject:
+    enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+# Relax RSpec metrics
+RSpec/ExampleLength:
+  Max: 20 # Defaut is 5
+
+RSpec/MultipleExpectations:
+  Max: 3 # Defaut is 1
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10 # Defaut is 5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+ospo@syngenta.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing
+
+- [Introduction](#introduction)
+- [Reporting issues](#reporting-issues)
+- [Contributing to code](#contributing-to-code)
+  - [Workflow for local development](#workflow-for-local-development)
+  - [Workflow for GitHub Codespaces in-browser development](#workflow-for-github-codespaces-in-browser-development)
+  - [About using VSCode](#about-using-vscode)
+
+## Introduction
+
+Contribution is welcome!
+
+This project adheres to the [Code of Conduct](CODE_OF_CONDUCT.md). We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Reporting issues
+
+Please, report any issues or bugs you find in the project's [Issues](https://github.com/syngenta/nomius/issues) section on GitHub.
+
+## Contributing to code
+
+### Workflow for local development
+
+1. [Fork the repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository).
+2. [Clone the forked repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository) to your local machine.
+3. Create a new branch for your changes:
+  `git checkout -b "feat/my-new-feature"`.
+4. Make your changes. We recommend using [VSCode + Docker](#about-using-vscode) locally.
+5. Commit your changes:
+  `git commit -m "feat: my new feature"`.
+6. Push your changes to your forked repo:
+  `git push origin feat/my-new-feature`.
+7. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) from your forked repo to the main repo.
+
+### Workflow for GitHub Codespaces in-browser development
+
+1. [Fork the repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository).
+2. Open Codespaces by clicking the green button **Code** on the top right corner of the repo and then **Open with Codespaces**.
+GitHub Codespaces will create and open a full-featured dev environment in the browser. You don't need to install anything locally.
+3. Create a new branch for your changes:
+  `git checkout -b "feat/my-new-feature"`
+4. Make your changes.
+5. Commit your changes:
+  `git commit -m "feat: my new feature"`
+6. Push your changes to your forked repo:
+  `git push origin feat/my-new-feature`
+7. [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) from your forked repo to the main repo.
+
+### About using VSCode
+
+The recommended way for local development is to use VSCode + Docker Desktop.
+
+- [VSCode](https://code.visualstudio.com/)
+- [Docker Desktop](https://www.docker.com/)
+
+VSCode supports `.devcontainer` configuration that will automatically build a full-featured dev environment for you. All plugins and hooks are already configured for you.
+
+```shell
+git clone git@github.com:syngenta/nomius.git
+cd nomius
+
+code .
+```

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:3.2.2
+LABEL maintainer="Oleksii Leonov <oleksii.leonov@syngenta.com>"
+
+RUN bundle config --global without development test
+
+WORKDIR /usr/src/app
+
+COPY . .
+RUN bundle install
+
+ENTRYPOINT ["bundle", "exec", "nomius"]

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Gem's dependencies are in nomius.gemspec.
+gemspec
+
+group :development do
+  gem "overcommit", "0.60.0"
+  gem "rubocop", "1.50.2"
+  gem "rubocop-rspec", "2.20.0"
+end
+
+group :test do
+  gem "rspec", "~> 3.12.0"
+end
+
+group :development, :test do
+  gem "rake"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Syngenta Group Co. Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,297 @@
+# Nomius — bulk domain & package name availability checker
+
+- [Description](#description)
+- [Ratio](#ratio)
+- [Installation](#installation)
+  - [Ruby gem](#ruby-gem)
+  - [Docker image](#docker-image)
+- [Usage](#usage)
+  - [Basic usage](#basic-usage)
+  - [Built-in help](#built-in-help)
+  - [Using TXT file as input](#using-txt-file-as-input)
+  - [Using CSV file as input](#using-csv-file-as-input)
+  - [Using CSV file as input and output](#using-csv-file-as-input-and-output)
+- [Using as a Ruby library](#using-as-a-ruby-library)
+- [Contributing](#contributing)
+- [Notes](#notes)
+
+## Description
+
+`nomius` takes a list of names as input and check domain name (`.com`, `.org`) and package name (RubyGems, PyPi, NPMjs, etc.) availability.
+
+The very basic usage example:
+
+```shell
+user@home:~$ nomius biochem biochemio biochemus
+
+┌───────────┬──────┬──────┬────┬────────┬─────┬─────┬─────┐
+│ Name      │ .com │ .org │ GH │ Docker │ npm │ pip │ gem │
+├───────────┼──────┼──────┼────┼────────┼─────┼─────┼─────┤
+│ biochem   │  ❌  │  ❌  │ ❌ │   ❌   │ ✅  │ ✅  │ ✅  │
+│ biochemio │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ biochemus │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │
+└───────────┴──────┴──────┴────┴────────┴─────┴─────┴─────┘
+```
+
+- `nomius` is a console utility. Could be installed & used as:
+  - [Ruby gem](#ruby-gem) (Ruby 2.6+);
+  - [Docker image](#docker-image).
+- Availability checks supported:
+  - domain name (`.com`,`.org`);
+  - [RubyGems](https://rubygems.org/) package name;
+  - [PyPi](https://pypi.org/) package name;
+  - [NPMjs](https://www.npmjs.com/) package name;
+  - [GitHub](https://github.com/) user/org name;
+  - [DockerHub](https://hub.docker.com/) user/org name.
+- Input is a name, list of names or CSV file with a list of names.
+- Output is a table with check results for each name. You could choose output to console or CSV file.
+
+## Ratio
+
+For example, you have created a new biochemistry project. Now you need to find a short and memorable name, with a domain and package name available to register.
+
+You may brainstorm dozens of names (or use a script to generate hundreds of names in different combinations):
+
+```txt
+liber, chimeia, bchem, chemb, biochem, chembio, biochemio, biochemus
+```
+
+Now you need to filter this list to names that have a domain name and package name available to register. But in popular domain zones (`.com`, `.org`) most of the short and memoizable names are already registered. Also, a good package name may be hard to find, especially if you want the name to be available across different languages and package managers.
+
+Manually checking all those names to have available domains (`.com`, `.org`) and package names (`pip`, `npm`, `gem`) is a tedious manual task.
+
+`nomius` will check all your names in a minute 🚀
+
+```shell
+user@home:~$ nomius liber chimeia bchem chemb biochem chembio biochemio biochemus
+
+┌───────────┬──────┬──────┬────┬────────┬─────┬─────┬─────┐
+│ Name      │ .com │ .org │ GH │ Docker │ npm │ pip │ gem │
+├───────────┼──────┼──────┼────┼────────┼─────┼─────┼─────┤
+│ bchem     │  ❌  │  ❌  │ ❌ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ biochem   │  ❌  │  ❌  │ ❌ │   ❌   │ ✅  │ ✅  │ ✅  │
+│ biochemio │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ biochemus │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ chemb     │  ❌  │  ✅  │ ❌ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ chembio   │  ❌  │  ❌  │ ❌ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ chimeia   │  ❌  │  ❌  │ ❌ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ liber     │  ❌  │  ❌  │ ❌ │   ❌   │ ❌  │ ❌  │ ✅  │
+└───────────┴──────┴──────┴────┴────────┴─────┴─────┴─────┘
+```
+
+## Installation
+
+### Ruby gem
+
+```shell
+# Install nomius gem.
+user@home:~$ gem install nomius
+
+# Run nomius.
+user@home:~$ nomius biochem
+
+┌─────────┬──────┬──────┬────┬────────┬─────┬─────┬─────┐
+│ Name    │ .com │ .org │ GH │ Docker │ npm │ pip │ gem │
+├─────────┼──────┼──────┼────┼────────┼─────┼─────┼─────┤
+│ biochem │  ❌  │  ❌  │ ❌ │   ❌   │ ✅  │ ✅  │ ✅  │
+└─────────┴──────┴──────┴────┴────────┴─────┴─────┴─────┘
+```
+
+### Docker image
+
+All the options are the same as for the Ruby gem.
+
+> Docker image is not published yet. But you could build it yourself.
+
+```shell
+# 1. Clone the repository.
+user@home:~$ git clone git@github.com:syngenta/nomius.git
+user@home:~$ cd nomius
+
+# 2. Build the Docker image.
+user@home:~$ docker build -t nomius .
+
+# 3. Run the Docker container.
+user@home:~$ docker run -t --rm nomius biochem
+
+┌─────────┬──────┬──────┬────┬────────┬─────┬─────┬─────┐
+│ Name    │ .com │ .org │ GH │ Docker │ npm │ pip │ gem │
+├─────────┼──────┼──────┼────┼────────┼─────┼─────┼─────┤
+│ biochem │  ❌  │  ❌  │ ❌ │   ❌   │ ✅  │ ✅  │ ✅  │
+└─────────┴──────┴──────┴────┴────────┴─────┴─────┴─────┘
+```
+
+## Usage
+
+### Basic usage
+
+```shell
+# Run nomius with a list of names to check.
+user@home:~$ nomius biochem biochemio biochemus
+
+┌───────────┬──────┬──────┬────┬────────┬─────┬─────┬─────┐
+│ Name      │ .com │ .org │ GH │ Docker │ npm │ pip │ gem │
+├───────────┼──────┼──────┼────┼────────┼─────┼─────┼─────┤
+│ biochem   │  ❌  │  ❌  │ ❌ │   ❌   │ ✅  │ ✅  │ ✅  │
+│ biochemio │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ biochemus │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │
+└───────────┴──────┴──────┴────┴────────┴─────┴─────┴─────┘
+```
+
+### Built-in help
+
+```shell
+# Run built-in help.
+user@home:~$ nomius --help
+
+Usage: nomius [OPTIONS] [NAMES...]
+
+Nomius — bulk domain & package name availability checker.
+
+Options:
+  -h, --help           Print usage
+  -i, --input string   Input file. Could be:
+                       - TXT with each name on a separate line;
+                       - CSV file with 2 columns: "name","comment" ("comment"
+                       is optional).
+
+  -o, --output string  Output CSV file
+  -s, --silent         Print less output
+      --version        Print version
+
+Examples:
+  Basic usage
+  Check "firstname" and "othername" names.
+    $ nomius firstname othername
+
+  Usage with a TXT file
+    $ nomius --input names.txt
+  or
+    $ cat names.txt | nomius
+  or
+    $ nomius < names.txt
+
+  Usage with a CSV file
+    $ nomius --input names.csv
+
+  Usage with a CSV file and output to a CSV file
+    $ nomius --input names.csv --output results.csv
+```
+
+### Using TXT file as input
+
+Use a TXT file with each name on a separate line.
+Wrap strings in quotes if it contains any non-alphanumeric characters.
+
+```txt
+biochem
+biochemio
+biochemus
+```
+
+```shell
+user@home:~$ nomius --input names.txt
+
+┌───────────┬──────┬──────┬────┬────────┬─────┬─────┬─────┐
+│ Name      │ .com │ .org │ GH │ Docker │ npm │ pip │ gem │
+├───────────┼──────┼──────┼────┼────────┼─────┼─────┼─────┤
+│ biochem   │  ❌  │  ❌  │ ❌ │   ❌   │ ✅  │ ✅  │ ✅  │
+│ biochemio │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │
+│ biochemus │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │
+└───────────┴──────┴──────┴────┴────────┴─────┴─────┴─────┘
+```
+
+Also, you could use shell pipe:
+
+```shell
+user@home:~$ cat names.txt | nomius
+# or
+user@home:~$ nomius < names.txt
+```
+
+### Using CSV file as input
+
+Input CSV file with 2 columns: _name_, _comment_.
+_Name_ is required, _comment_ is optional:
+
+```CSV
+biochem,"short of bio+chemistry"
+biochemio,"short of biochemistry + fancy ending"
+biochemus,"short of biochemistry + fancy ending"
+```
+
+```shell
+user@home:~$ nomius --input names.csv
+
+┌───────────┬──────┬──────┬────┬────────┬─────┬─────┬─────┬──────────────────────────────────────┐
+│ Name      │ .com │ .org │ GH │ Docker │ npm │ pip │ gem │ Comment                              │
+├───────────┼──────┼──────┼────┼────────┼─────┼─────┼─────┼──────────────────────────────────────┤
+│ biochem   │  ❌  │  ❌  │ ❌ │   ❌   │ ✅  │ ✅  │ ✅  │ short of bio+chemistry               │
+│ biochemio │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │ short of biochemistry + fancy ending │
+│ biochemus │  ✅  │  ✅  │ ✅ │   ✅   │ ✅  │ ✅  │ ✅  │ short of biochemistry + fancy ending │
+└───────────┴──────┴──────┴────┴────────┴─────┴─────┴─────┴──────────────────────────────────────┘
+```
+
+### Using CSV file as input and output
+
+```shell
+user@home:~$ nomius --input names.csv --output results.csv
+```
+
+Output in `results.csv` CSV file:
+
+```csv
+Name,Comment,bchem.com,bchem.org,GitHub.com,hub.docker.com,NPMjs.com,PyPi.org,RubyGems.org
+biochem,short of bio+chemistry,-,-,-,-,+,+,+
+biochemio,short of biochemistry + fancy ending,+,+,+,+,+,+,+
+biochemus,short of biochemistry + fancy ending,+,+,+,+,+,+,+
+```
+
+## Using as a Ruby library
+
+`nomius` is designed to be a CLI tool, but you could use it as a Ruby library.
+
+```shell
+# Install nomius gem.
+user@home:~$ gem install nomius
+```
+
+```ruby
+require 'nomius'
+
+# Run all checks:
+results = Nomius::BulkChecker.check(
+  names: ["biochem", "biochemio", "biochemus"]
+)
+
+# Run only specific checks:
+results = Nomius::BulkChecker.check(
+  names: ["biochem", "biochemio", "biochemus"],
+  detectors: [Nomius::Detector::DomainComDetector]
+)
+
+# Run with verbose logger:
+results = Nomius::BulkChecker.check(
+  names: ["biochem", "biochemio", "biochemus"],
+  logger: Nomius::Logger::Verbose.new
+)
+
+# Use names with comments
+names = [
+  Nomius::Name.new(name: "biochem", comment: 'short of bio+chemistry'),
+  Nomius::Name.new(name: "biochemio", comment: 'short of biochemistry + fancy ending')
+]
+results = Nomius::BulkChecker.check(names: names)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/syngenta/nomius](https://github.com/syngenta/nomius).
+
+Please, check our [Contribution guide](CONTRIBUTING.md) for more details.
+
+This project adheres to the [Code of Conduct](CODE_OF_CONDUCT.md). We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Notes
+
+- `nomius` uses DNS and WHOIS checks to verify domain name availability. Results may not be 100% precise.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec]

data/exe/nomius

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "nomius/cli"
+
+Nomius::CLI.run