[chore] update README.md

README.md

@@ -1,117 +1,62 @@
-<p align="center">
-  <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
-</p>
+# setup-poetry
 
-# Create a JavaScript Action using TypeScript
+[![Build Status](https://github.com/Gr1N/setup-poetry/workflows/default/badge.svg)](https://github.com/Gr1N/setup-poetry/actions?query=workflow%3Adefault)
 
-Use this template to bootstrap the creation of a JavaScript action.:rocket:
+This action sets up a [Poetry](https://python-poetry.org) for use in actions by installing a version of Poetry and adding to PATH. The action will fail if no matching versions are found.
 
-This template includes compilication support, tests, a validation workflow, publishing, and versioning guidance.
+This action supports versions of:
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+- Python `>=3.6`;
+- Poetry `>=1.0`.
 
-## Create an action from this template
+## Usage
 
-Click the `Use this Template` and provide the new repo details for your action
+See [action.yml](https://github.com/Gr1N/setup-poetry/blob/master/action.yml).
 
-## Code in Master
+### Install latest available version of Poetry
 
-Install the dependencies
-```bash
-$ npm install
-```
-
-Build the typescript
-```bash
-$ npm run build
-```
-
-Run the tests :heavy_check_mark:
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-
-...
-```
-
-## Change action.yml
-
-The action.yml contains defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
-
-## Change the Code
-
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
-
-```javascript
-import * as core from '@actions/core';
-...
-
-async function run() {
-  try {
-      ...
-  }
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Publish to a distribution branch
-
-Actions are run from GitHub repos.  We will create a releases branch and only checkin production modules (core in this case).
-
-Comment out node_modules in .gitignore and create a releases/v1 branch
-```bash
-# comment out in distribution branches
-# node_modules/
+```yaml
+steps:
+  - uses: actions/checkout@v1
+  - uses: actions/setup-python@v1
+    with:
+      python-version: 3.8
+  - uses: Gr1N/setup-poetry@v1
+  - run: poetry --version
 ```
 
-```bash
-$ git checkout -b releases/v1
-$ git commit -a -m "prod dependencies"
-```
+### Exact version of Poetry to install, using SemVer's version syntax
 
-```bash
-$ npm prune --production
-$ git add node_modules
-$ git commit -a -m "prod dependencies"
-$ git push origin releases/v1
+```yaml
+steps:
+  - uses: actions/checkout@v1
+  - uses: actions/setup-python@v1
+    with:
+      python-version: 3.8
+  - uses: Gr1N/setup-poetry@v1
+    with:
+      poetry-version: 1.0.0
+  - run: poetry --version
 ```
 
-Your action is now published! :rocket:
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Validate
-
-You can now validate the action by referencing the releases/v1 branch
+### Allow to install prerelease versions of Poetry
 
 ```yaml
-uses: actions/typescript-action@releases/v1
-with:
-  milliseconds: 1000
+steps:
+  - uses: actions/checkout@v1
+  - uses: actions/setup-python@v1
+    with:
+      python-version: 3.8
+  - uses: Gr1N/setup-poetry@v1
+    with:
+      poetry-preview: true
+  - run: poetry --version
 ```
 
-See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
+## Contributing
 
-## Usage:
+Feel free to submit any PR you want, they are always welcome.
 
-After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and tested action
+## License
 
-```yaml
-uses: actions/typescript-action@v1
-with:
-  milliseconds: 1000
-```
+`setup-poetry` is licensed under the MIT license. See the license file for details.

package.json

@@ -19,8 +19,9 @@
   },
   "keywords": [
     "actions",
-    "node",
-    "setup"
+    "setup",
+    "python",
+    "poetry"
   ],
   "author": "Nikita Grishko",
   "license": "MIT",