diff --git a/README.md b/README.md index b59d7f32..e075003d 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,22 @@ If you handle multiple dependencies in your project is better to add a *conan.co conan-center ``` +### [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) \ No newline at end of file