diff --git a/README.md b/README.md index 3cf8e67..f3e4a8a 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,51 @@ # ClickUp <-> Phabricator / Phorge bot Bot to help migration from ClickUp to Phabricator / Phorge (and vice-versa honestly). +## Available features + +* automatically import new ClickUp Tasks in Phabricator (with title, description) + * automatically update the ClickUp Task to mention the Phabricator Task URL + * automatically update the Phabricator Task to mention the ClickUp Task URL + * automatically assign the right Phabricator Tag (associated to the corresponding ClickUp folder) +* automatically import new ClickUp Task comments into their related Phabricator Task + ## Dev preparation ``` sudo apt install php-cli composer ``` ## Dev installation ``` composer install ``` ## Deploy on production ``` rsync --recursive --delete ../clickup-phabricator/ ravotti93:/var/www/phabricator/scripts/public/clickup ``` + +## License + +Copyright (C) 2022 Valerio Bozzolan, contributors + +This software was developed and tested and released in non-working +hours so the copyright does NOT belong to the company. Any company +can use this software without Valerio's written consent, included +ER Informatica. + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .