From fa95619022bc4e161dd0e043f41f60b9c14c7e50 Mon Sep 17 00:00:00 2001 From: Greg Grossmeier Date: Tue, 21 Nov 2017 18:49:36 +0000 Subject: [PATCH] Add a limitations section to README Include the financial cost section and add a note about large files (and reference chunking). --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index a3954d7..779ba8e 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,14 @@ B2 credentials may either be given as arguments to `initremote` ( `accountid=XXX Optionally, you may pass `prefix=something` to have `git-annex-remote-b2` prepend `something/` to the keys it stores in B2. +Limitations +=========== + +Large files +----------- + +By default, B2 only supports files up to 5GiB. To work around this limitation you can use [git-annex's chunk support](http://git-annex.branchable.com/chunking/) by passing `chunk=100MiB` when you do the initremote, or any time after by doing `git-annex enableremote b2 chunk=100MiB`. + Improving the financial cost of this remote -------------------------------------------