From 490664d17407193f4211456f5389441f9b7d855f Mon Sep 17 00:00:00 2001 From: Robert Ashton Date: Mon, 4 Dec 2023 17:12:29 +0000 Subject: [PATCH] Flesh out README a bit more --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f507125..5ce27ce 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,13 @@ An [`orderly1`](https://github.com/vimc/orderly1) remote hosted on a shared drive. Either a network share or a synced onedrive. -### Usage +## Installation + +``` +remotes::install_github("vimc/orderly.sharedrive") +``` + +## Usage Configure your `orderly_config.yml` as, for example: @@ -22,7 +28,7 @@ remote: Where -* `path` is the path to your shared drive. This can be an environment variable +* `path` is the path to your shared drive. We recommend you use an environment variable stored in `orderly_envir.yml` if you are working with other people `orderly.sharedrive` will store files as `archive//` where `` is the report name and `` is a zip archive of the report contents. These must be treated as read-only and must not be modified (they do not have a file extension to help this).