From f705dfd43acac2a99a6dba35768ef89a27dd06c9 Mon Sep 17 00:00:00 2001 From: Marco Dalla Santa Date: Sun, 20 Dec 2020 18:57:10 +0100 Subject: [PATCH] Changed README --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 228cd9b..fc7a3fb 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # ssh-scp-deploy [![Action type](https://img.shields.io/badge/Docker%20action-262b31?logo=docker&logoColor=2496ed)](https://docs.github.com/en/actions/creating-actions/about-actions#types-of-actions) -[![License](https://img.shields.io/github/license/underscore69/ssh-scp-deploy)](LICENSE) -[![Pipeline status](https://img.shields.io/github/workflow/status/underscore69/ssh-scp-deploy/Test?label=test)](./) +[![License](https://img.shields.io/github/license/mdallasanta/ssh-scp-deploy)](LICENSE) +[![Pipeline status](https://img.shields.io/github/workflow/status/mdallasanta/ssh-scp-deploy/Test?label=test)](./) -This action provide an easy and higly customizable way to upload files via scp and execute a set of command via ssh before or/and after. +## ❔ Why should I use this action? -## Supported runners +Because this action provide an easy and higly customizable way to upload files via scp and execute a set of command via ssh before or/and after. +I use this in my personal project to deploy an application to a remote server or to upload a file via scp. + +## 🏃 Supported runners [![Supported runner](https://img.shields.io/badge/Linux-262b31?style=for-the-badge&logo=linux&logoColor=fcc624)](https://docs.github.com/en/actions/creating-actions/about-actions#docker-container-actions) @@ -15,13 +18,13 @@ This action provide an easy and higly customizable way to upload files via scp a **Marco Dalla Santa** * Twitter: [@marcodallasanta](https://twitter.com/Marco16032098) -* Github: [@marcodallasanta](https://github.com/underscore69) +* Github: [@marcodallasanta](https://github.com/mdallasanta) * LinkedIn: [@marcodallasanta](https://www.linkedin.com/in/marco-dalla-santa-72bb4015a/) -## Usage +## ⚙️ Usage ```yaml - - uses: underscore69/ssh-scp-deploy@v1.0.0 + - uses: mdallasanta/ssh-scp-deploy@{version} with: local: './' # Local file path - REQUIRED false - DEFAULT ./ remote: '~/' # Remote file path - REQUIRED false - DEFAULT ~/ @@ -40,7 +43,14 @@ This action provide an easy and higly customizable way to upload files via scp a Contributions, issues and feature requests are welcome! -Feel free to check [issues page](https://github.com/underscore69/ssh-scp-deploy/issues). +Feel free to check [issues page](https://github.com/mdallasanta/ssh-scp-deploy/issues). + +## 🙏Thanks + +Thanks to [Raphaël Bussa](https://github.com/raphaelbussa) that helped in testing. ## 📝 License + +Copyright © 2020 [Marco Dalla Santa]() + The source code, scripts and documentation in this project are released under the [MIT License](LICENSE) \ No newline at end of file