From 557c15f040f85b1e62fe6144abb521956acbb310 Mon Sep 17 00:00:00 2001 From: Clarence Castillo Date: Wed, 8 Apr 2020 22:08:34 +0800 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7105b17..5876f89 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,28 @@ For both primary commands: Resulting synonyms or antonyms will be sequentially listed according to user rating. -## Licensing and Acknowledgement ## +## Development ## + +Use the `init.sh` script to install the required dependencies inside the `src` folder. When you're ready to test or export, copy the entire `src` folder to the existing workflow directory. + +## Releases ## + +When preparing a new release, don't forget to: + +1. Bump `version` file +2. Update `user-agent` version inside `src/api.py` (hopefully the devs will appreciate this) +3. Update the exported workflow following the format `Powerthesaurus-x.x.x.alfredworkflow` + + +## Licensing ## This workflow is released under the [MIT Licence](http://opensource.org/licenses/MIT). +By using this workflow, you acknowledge, understand and signify your agreement to Power Thesaurus Website's [terms and conditions](https://www.powerthesaurus.org/_terms_conditions), and [privacy statement](https://www.powerthesaurus.org/_privacy_statement). + +## Acknowledgements ## + +Big shoutout to the heroes that made Power Thesaurus possible. Help keep the platform free for everyone by [giving your support](https://www.powerthesaurus.org/_about). + It is heavily based on [deanishe's](https://github.com/deanishe) [Alfred-Workflow](http://www.deanishe.net/alfred-workflow/), also [MIT-licensed](http://opensource.org/licenses/MIT). - -By using this workflow, you acknowledge, understand and signify your agreement to Power Thesaurus Website's [terms and conditions](https://www.powerthesaurus.org/_terms_conditions), and [privacy statement](https://www.powerthesaurus.org/_privacy_statement).