diff --git a/README.md b/README.md index 351d95c..67f37f6 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,61 @@ Alfred Workflow to interact with the Joplin API. ## Requirements -* Curl -* Perl 5 +- Curl +- Perl 5 + - JSON module ## Installation +### Curl + +```bash +brew install curl +``` + +[Brew Install Insturctions](https://brew.sh/) + ### Joplin Web Clipper -To use Joplin's API the Web Clipper needs to be enabled. +To use Joplin's API, the Web Clipper needs to be enabled. -This is done by going to Joplin Prefernces (Options) -> Web Clipper and enable the web clipper. +This is done by going to Joplin Preferences (Options) -> Web Clipper and enabling the web clipper. Note the Port that it is running on and copy your Authorization Token. +### Perl + +Perl should be installed on your Mac device. + +```bash +brew install perl +``` + +[Brew Install Insturctions](https://brew.sh/) + +#### JSON Module + +```bash +cpan install JSON +``` + + ### Workflow Installation -~~Find the latest release on the right-hand side of the main [README](https://github.com/skeletonkey/joplin_alfred_workflow) page (right side). Download the '.alfredworkflow' file for the release you wish to install. Next, open the file on your desktop - this should open/install the workflow in Alfred.~~ +Find the latest release on the right-hand side of the main [README](https://github.com/skeletonkey/joplin_alfred_workflow) page (right side). Download the '.alfredworkflow' file for the release you wish to install. Next, open the file on your desktop - this should open/install the workflow in Alfred. -### Workflow Configuration +#### Workflow Configuration -In Alfred select the Joplin Workflow and open the Configuration Build (top right, it looks like '(x)'). +In Alfred, select the Joplin Workflow and open the Configuration Build (top right, it looks like '(x)'). -On the Environment Variables tab provide your token for JOPLIN_TOKEN and ensure that JOPLIN_URL has the correct port. +On the Environment Variables tab, provide your token for JOPLIN_TOKEN and ensure that JOPLIN_URL has the correct port. ## Usage ### Search -#### js +#### js Search all of Joplin for the string entered. + +*BUG* currently, words separated with a space are treated as two tokens with an AND operation instead of one string.