README.md

GiphyScraper

Running this project:

1. Export your Giphy API key as an environment variable with the name of GIPHY_API_KEY
2. Run mix deps.get to obtain any necessary dependencies

From iex

3. Run iex using mix
4. Run GiphyScraper.search("<your term here>"), with whatever term you prefer

From the command-line

3. Run mix escript.build
4. Run the executable (likely ./giphy_scraper) with either the -q or --query flags followed by your search term (e.g., ./giphy_scraper -q patriots)

Installation

If available in Hex, the package can be installed by adding giphy_scraper to your list of dependencies in mix.exs:

def deps do
  [
    {:giphy_scraper, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/giphy_scraper.