Skip to content

Updated doc #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Almouro wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated doc #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Capistrano::TransferProgress

TODO: Write a gem description
Hooks on capistrano transfers and provides a callback that displays a progressbar with current transfer progress.

Can handle:
* Simultaneous transfers
* SCP and SFTP
* Multiple files (recursive)
* Uploads & Downloads

Cannot handle:
* SFTP Downloads as they do not report the total file size

## Installation

Expand All @@ -18,7 +27,14 @@ Or install it yourself as:

## Usage

TODO: Write usage instructions here
Add this line to your application's Capfile:

require 'capistrano-transfer_progress'

That's it!
You can now see progress bars on your capistrano transfers looking like this:

Transfering: 64% |ooooooooooooo | ETA: 0:02:11

## Contributing

Expand Down