diff --git a/README.md b/README.md index 0a7f0f7..22662c2 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ # actions/add-to-project -🚨 **This action is a work in progress. Please do not use it except for -experimentation until a release has been prepared.** 🚨 - Use this action to automatically add issues to a GitHub Project. Note that this is for [GitHub Projects (beta)](https://docs.github.com/en/issues/trying-out-the-new-projects-experience/about-projects), not the original GitHub Projects. +## Current Status + +![Build status](https://github.com/github/add-to-project/workflows/test/badge.svg) + +🚨 **This action is a work-in-progress. Please do not use it except for +experimentation until a release has been prepared.** 🚨 + +## Usage + To use the action, create a workflow that runs when issues are opened in your repository. Run this action in a step, optionally configuring any filters you may want to add, such as only adding issues with certain labels. @@ -76,3 +82,7 @@ the "dist/" directory. ``` Now, a release can be created from the branch containing the built action. + +# License + +The scripts and documentation in this project are released under the [MIT License](LICENSE)