From e6fd1d9667be4bf1d73a85a44cd563c91cbf0d98 Mon Sep 17 00:00:00 2001 From: Matteo Fordiani Date: Sun, 13 Aug 2023 23:12:15 +0200 Subject: [PATCH] docs(readme): update README --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4309d87..9389246 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ ![Tests](https://github.com/matteo4diani/poetry-semantic-release-test/actions/workflows/test.yml/badge.svg) ![Release](https://github.com/matteo4diani/poetry-semantic-release/actions/workflows/release.yml/badge.svg) -# Poetry Semantic Release -A composite GitHub Action to release simple Python packages on GitHub and PyPI following semantic versioning and conventional commits. +# semantic-poetry 🪶 +[semantic-poetry](https://github.com/marketplace/actions/semantic-poetry) is a GitHub Action that automates the release of [poetry](https://python-poetry.org/)-based Python packages on GitHub and PyPI following [semantic versioning](https://semver.org) and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) standards. ## Usage -This action automates [semantic versioning](https://semver.org) and distribution of Python projects by leveraging [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary). - To use it in your CI: 1. Generate a PyPI Token from PyPI: https://pypi.org/help/#apitoken 2. Set your PyPI Token as a repository secret named `PYPI_TOKEN`: https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository