README.md

   1 # Homebrew Formulae
   2
   3 [Homebrew Formulae](https://formulae.brew.sh) is an online package browser for [Homebrew](https://brew.sh).
   4
   5 It displays all packages in the [Homebrew/homebrew-core](https://github.com/Homebrew/homebrew-core) and [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask). A [GitHub Action](https://github.com/Homebrew/formulae.brew.sh/blob/master/.github/workflows/tests.yml) is run periodically which pulls changes from each tap and deploys the site to GitHub Pages.
   6
   7 ## JSON API
   8 It also provides a JSON API for all packages (or individual packages) in each tap and their related analytics. This JSON data is used for the creation of the HTML resources on this site.
   9
  10 Currently available:
  11
  12 - List metadata for all formulae and casks
  13 - Get metadata for each formula and cask
  14 - List analytics events for all formulae and casks
  15 - List analytics events for each formula and cask
  16
  17 Read more in the [JSON API documentation](https://formulae.brew.sh/docs/api/).
  18
  19 ## Usage
  20 Open <https://formulae.brew.sh/> in your web browser.
  21
  22 To instead run the site locally, run:
  23 ```bash
  24 git clone https://github.com/Homebrew/formulae.brew.sh
  25 cd formulae.brew.sh
  26 rake generate
  27 bundle install
  28 bundle exec jekyll serve
  29 ```
  30
  31 ## Search
  32 Search is indexed by Algolia crawler at https://crawler.algolia.com/admin/crawlers/26b9e6e2-bce4-4f42-9930-6b6ddf06cc9e/overview.
  33 This is only accessible by brew organisation members.
  34
  35 ## License
  36 Code is under the [BSD 2-clause "Simplified" License](LICENSE.txt).