From 36ddebb2b375177589b7cb8c54a7bd53253569fb Mon Sep 17 00:00:00 2001 From: SSE4 Date: Tue, 29 Jan 2019 12:41:03 +0700 Subject: [PATCH] - update README Signed-off-by: SSE4 --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 4a07b308..3efd59af 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,22 @@ These are the hooks currently available in this repository This hook checks that some important attributes are present in the ``ConanFile``: url, license and description, and will output a warning for the missing ones. +### [GitHub Update](plugins/github-updater.py) + +This Conan hook reads your recipe and updates its GitHub repository properties using the attributes. + +The following attributes are updated: + +- homepage + +- description + +- topics + +It's necessary to pass GitHub token by environment variable: *GITHUB_TOKEN*. + +The hook is automatically called when *export* command is executed. + ## License [MIT License](LICENSE)