/the-iron-searcher

Primary LanguageCrystalMIT LicenseMIT

The Iron Searcher

A text file searching tool like The Silver Searcher, but in Crystal.

I also wrote the equivalent of in Ruby as a separate exercise. I implore you to go read the README for some history.

This is an EDUCATIONAL endeavor of my part, to mimic The Silver Searcher tool using the Crystal language concurrency feaures (and to a lesser degree learn how to write a CLI program in Crystal).

What's in a name?

The Iron Searcher. The periodic table symbol for the element Iron is fe. Iron ions are what give Aquamarine the color blue. Aquamarine, is a variety of Beryl. The largest known naturally occurring crystal is a crystal of Beryl. Go read more about all this here.

Usage

Command usage: fe SEARCH_TERM SEARCH_DIRECTORY

Sample command usage: fe crystal ~/some_directory

Development

Run shards build to generate a binary file to run from source code.

Contributing

  1. Fork it (https://github.com/rrevi/the-iron-searcher/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors