From ef1a0381ec5db2bd838b12f0769992f110e7b87a Mon Sep 17 00:00:00 2001 From: Dan Foreman-Mackey Date: Fri, 31 May 2019 10:17:15 -0700 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c227b41..5009301 100644 --- a/README.md +++ b/README.md @@ -18,19 +18,18 @@ click to import that into Alfred. You can also install the development version of the workflow by cloning this repository into the `~/Library/Application Support/Alfred/Alfred.alfredpreferences/workflows` directory. -## Usage +To get all the features out of this worflow, you should also install [Andy Casey's ads +library](https://github.com/andycasey/ads). Then you can either put your API key in the +`~/.ads/dev_key` file or set it using the `ADS_API_KEY` variable in the workflow interface. -To get started you can just open Alfred and type `ads ` to start searching. This will let you -perform queries using the ADS website. If you want to perform queries within Alfred as well, -you'll need to install [Andy Casey's ads library](https://github.com/andycasey/ads) and save -your ADS API key in the `~/.ads/dev_key` file (the environment variable version won't work). By default Alfred uses the system Python, but you can change that by putting the path to your -favorite Python executable in the file `~/.ads/python`. +favorite Python executable in the `ADS_PYTHON` variable. -## Example queries +## Usage -This workflow is designed to search authors and years only. For example, if you want to search -for papers by an author named "Spergel" in 2015, you can execute: +To get started you can just open Alfred and type `ads ` to start searching. This workflow is +designed to search authors and years only. For example, if you want to search for papers by an +author named "Spergel" in 2015, you can execute: ``` ads spergel 2015