Changed README

This commit is contained in:
Marco Dalla Santa
2020-12-20 18:57:10 +01:00
parent c3ed5c67e7
commit f705dfd43a

View File

@@ -1,12 +1,15 @@
# ssh-scp-deploy # 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) [![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) [![License](https://img.shields.io/github/license/mdallasanta/ssh-scp-deploy)](LICENSE)
[![Pipeline status](https://img.shields.io/github/workflow/status/underscore69/ssh-scp-deploy/Test?label=test)](./) [![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) [![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** **Marco Dalla Santa**
* Twitter: [@marcodallasanta](https://twitter.com/Marco16032098) * 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/) * LinkedIn: [@marcodallasanta](https://www.linkedin.com/in/marco-dalla-santa-72bb4015a/)
## Usage ## ⚙️ Usage
```yaml ```yaml
- uses: underscore69/ssh-scp-deploy@v1.0.0 - uses: mdallasanta/ssh-scp-deploy@{version}
with: with:
local: './' # Local file path - REQUIRED false - DEFAULT ./ local: './' # Local file path - REQUIRED false - DEFAULT ./
remote: '~/' # Remote 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! 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 ## 📝 License
Copyright © 2020 [Marco Dalla Santa]()
The source code, scripts and documentation in this project are released under the [MIT License](LICENSE) The source code, scripts and documentation in this project are released under the [MIT License](LICENSE)