From 2f2029fed523d56a15038ea58ff193c92cfaace2 Mon Sep 17 00:00:00 2001 From: HerrH Date: Thu, 11 Oct 2018 12:18:36 +0200 Subject: [PATCH] Improved and updated the readme Updated providers list, added links to docs, improved readability --- README.md | 91 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 58 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 2c6ee2eee..59753b7f4 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,11 @@ [Website](https://rclone.org) | [Documentation](https://rclone.org/docs/) | +[Download](https://rclone.org/downloads/) | [Contributing](CONTRIBUTING.md) | [Changelog](https://rclone.org/changelog/) | [Installation](https://rclone.org/install/) | -[Forum](https://forum.rclone.org/) +[Forum](https://forum.rclone.org/) | [G+](https://google.com/+RcloneOrg) [![Build Status](https://travis-ci.org/ncw/rclone.svg?branch=master)](https://travis-ci.org/ncw/rclone) @@ -13,50 +14,74 @@ [![CircleCI](https://circleci.com/gh/ncw/rclone/tree/master.svg?style=svg)](https://circleci.com/gh/ncw/rclone/tree/master) [![GoDoc](https://godoc.org/github.com/ncw/rclone?status.svg)](https://godoc.org/github.com/ncw/rclone) -Rclone is a command line program to sync files and directories to and from +# Rclone - * Amazon Drive ([See note](https://rclone.org/amazonclouddrive/#status)) - * Amazon S3 / Dreamhost / Ceph / Minio / Wasabi - * Backblaze B2 - * Box - * Dropbox - * FTP - * Google Cloud Storage - * Google Drive - * HTTP - * Hubic - * Jottacloud - * Mega - * Microsoft Azure Blob Storage - * Microsoft OneDrive - * OpenDrive - * Openstack Swift / Rackspace cloud files / Memset Memstore / OVH / Oracle Cloud Storage - * pCloud - * QingStor - * SFTP - * Webdav / Owncloud / Nextcloud - * Yandex Disk - * The local filesystem +Rclone *("rsync for cloud storage")* is a command line program to sync files and directories to and from different cloud storage providers. -Features +## Storage providers + + * Amazon Drive [:page_facing_up:](https://rclone.org/amazonclouddrive/) ([See note](https://rclone.org/amazonclouddrive/#status)) + * Amazon S3 [:page_facing_up:](https://rclone.org/s3/) + * Backblaze B2 [:page_facing_up:](https://rclone.org/b2/) + * Box [:page_facing_up:](https://rclone.org/box/) + * Ceph [:page_facing_up:](https://rclone.org/s3/#ceph) + * DigitalOcean Spaces [:page_facing_up:](https://rclone.org/s3/#digitalocean-spaces) + * Dreamhost [:page_facing_up:](https://rclone.org/s3/#dreamhost) + * Dropbox [:page_facing_up:](https://rclone.org/dropbox/) + * FTP [:page_facing_up:](https://rclone.org/ftp/) + * Google Cloud Storage [:page_facing_up:](https://rclone.org/googlecloudstorage/) + * Google Drive [:page_facing_up:](https://rclone.org/drive/) + * HTTP [:page_facing_up:](https://rclone.org/http/) + * Hubic [:page_facing_up:](https://rclone.org/hubic/) + * Jottacloud [:page_facing_up:](https://rclone.org/jottacloud/) + * IBM COS S3 [:page_facing_up:](https://rclone.org/s3/#ibm-cos-s3) + * Memset Memstore [:page_facing_up:](https://rclone.org/swift/) + * Mega [:page_facing_up:](https://rclone.org/mega/) + * Microsoft Azure Blob Storage [:page_facing_up:](https://rclone.org/azureblob/) + * Microsoft OneDrive [:page_facing_up:](https://rclone.org/onedrive/) + * Minio [:page_facing_up:](https://rclone.org/s3/#minio) + * Nextcloud [:page_facing_up:](https://rclone.org/webdav/#nextcloud) + * OVH [:page_facing_up:](https://rclone.org/swift/) + * OpenDrive [:page_facing_up:](https://rclone.org/opendrive/) + * Openstack Swift [:page_facing_up:](https://rclone.org/swift/) + * Oracle Cloud Storage [:page_facing_up:](https://rclone.org/swift/) + * ownCloud [:page_facing_up:](https://rclone.org/webdav/#owncloud) + * pCloud [:page_facing_up:](https://rclone.org/pcloud/) + * put.io [:page_facing_up:](https://rclone.org/webdav/#put-io) + * QingStor [:page_facing_up:](https://rclone.org/qingstor/) + * Rackspace Cloud Files [:page_facing_up:](https://rclone.org/swift/) + * SFTP [:page_facing_up:](https://rclone.org/sftp/) + * Wasabi [:page_facing_up:](https://rclone.org/s3/#wasabi) + * WebDAV [:page_facing_up:](https://rclone.org/webdav/) + * Yandex Disk [:page_facing_up:](https://rclone.org/yandex/) + * The local filesystem [:page_facing_up:](https://rclone.org/local/) + +## Features * MD5/SHA1 hashes checked at all times for file integrity * Timestamps preserved on files * Partial syncs supported on a whole file basis - * Copy mode to just copy new/changed files - * Sync (one way) mode to make a directory identical - * Check mode to check for file hash equality + * [Copy](https://rclone.org/commands/rclone_copy/) mode to just copy new/changed files + * [Sync](https://rclone.org/commands/rclone_sync/) (one way) mode to make a directory identical + * [Check](https://rclone.org/commands/rclone_check/) mode to check for file hash equality * Can sync to and from network, eg two different cloud accounts - * Optional encryption (Crypt) - * Optional FUSE mount + * Optional encryption ([Crypt](https://rclone.org/crypt/)) + * Optional cache ([Cache](https://rclone.org/cache/)) + * Optional FUSE mount ([rclone mount](https://rclone.org/commands/rclone_mount/)) -See the home page for installation, usage, documentation, changelog -and configuration walkthroughs. +## Installation & documentation + +Please see the rclone website for installation, usage, documentation, +changelog and configuration walkthroughs. * https://rclone.org/ +## Downloads + + * https://rclone.org/downloads/ + License ------- This is free software under the terms of MIT the license (check the -COPYING file included in this package). +[COPYING file](/rclone/COPYING) included in this package).