diff --git a/README.md b/README.md index 0fe86b8..8ca86fb 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,22 @@ repeatable, and customizable way.** pkg> add PkgTemplates ``` +## Plugins + +`PkgTemplates` is based on plugins which handle the setup of individual package components. +The available plugins are: + +* Continuous Integration (CI) + * [Travis CI](https://travis-ci.com) (Linux, MacOS) + * [AppVeyor](https://appveyor.com) (Windows) + * [GitLabCI](https://gitlab.com) (Linux) + * [CirrusCI](https://cirrus-ci.org) (FreeBSD) +* Code Coverage + * [Codecov](https://codecov.io) + * [Coveralls](https://coveralls.io) +* Documentation + * [GitHubPages](https://pages.github.com) + ## Usage Assuming you have the relatively standard Git options `user.name`, `user.email` and `github.user` set up globally with `git config --global`, the simplest template requires no arguments: @@ -61,6 +77,7 @@ julia> t = Template(; Coveralls(), AppVeyor(), GitHubPages(), + CirrusCI(), ], ) Template: diff --git a/docs/src/index.md b/docs/src/index.md index 6935a8c..a5d4da6 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -15,6 +15,22 @@ repeatable, and customizable way.** pkg> add PkgTemplates ``` +## Plugins + +`PkgTemplates` is based on plugins which handle the setup of individual package components. +The available plugins are: + +* Continuous Integration (CI) + * [Travis CI](https://travis-ci.com) (Linux, MacOS) + * [AppVeyor](https://appveyor.com) (Windows) + * [GitLabCI](https://gitlab.com) (Linux) + * [CirrusCI](https://cirrus-ci.org) (FreeBSD) +* Code Coverage + * [Codecov](https://codecov.io) + * [Coveralls](https://coveralls.io) +* Documentation + * [GitHubPages](https://pages.github.com) + ## Usage ```@setup usage @@ -56,6 +72,7 @@ t = Template(; Coveralls(), AppVeyor(), GitHubPages(), + CirrusCI(), ], ) generate("MyPkg2", t) diff --git a/docs/src/pages/plugins.md b/docs/src/pages/plugins.md index 6b643e7..dd4f07a 100644 --- a/docs/src/pages/plugins.md +++ b/docs/src/pages/plugins.md @@ -14,6 +14,7 @@ describes plugins that already exist; for information on writing your own plugin TravisCI AppVeyor GitLabCI +CirrusCI ``` ## Code Coverage