README

README.md

@@ -0,0 +1,11 @@
+This is an action which sets up poetry for a project that uses [Poetry](https://python-poetry.org/) to manage its dependencies.
+It requires a `poetry.lock` file to be present in the root of the repository. It:
+
+- calls [`actions/setup-python`](https://github.com/actions/setup-python),
+- `pip`-installs `poetry`,
+- `poetry install`-s the current project,
+- uses [`actions/cache`](https://github.com/actions/cache) to cache the poetry installation and the virtual environment it manages.
+
+From the point, the caller of the action can run commands within the poetry-managed environment with `poetry run`.
+
+This particular action is loosely based on [`snok/install-poetry`](https://github.com/snok/install-poetry): in particular, the advice from its README on handling caching.