From 330ac89844ca516a78e945deb1033a813e7b10fb Mon Sep 17 00:00:00 2001 From: jld3103 Date: Sat, 23 Jul 2022 12:45:39 +0200 Subject: [PATCH] nextcloud: Add installation instructions --- packages/nextcloud/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/packages/nextcloud/README.md b/packages/nextcloud/README.md index a533f558..8b949e33 100644 --- a/packages/nextcloud/README.md +++ b/packages/nextcloud/README.md @@ -4,6 +4,20 @@ A Nextcloud client written in Dart. This client will become the replacement for https://github.com/jld3103/dart-nextcloud at some point ([See](https://github.com/jld3103/nextcloud-neon/issues/1)). + +## Installing + +In the future this code will be available at https://pub.dev/packages/nextcloud, but for now you have to include it via git in your pubspec.yaml: +```yaml +dependencies: + nextcloud: + git: + url: https://github.com/jld3103/nextcloud-neon + path: packages/nextcloud + ref: $COMMIT +``` +You can either remove the `ref` or use a commit hash. It's not recommended to remove it, because then the version will be updated very often. + ## Development Except for WebDAV all client code is generated using OpenAPI specs which can be found in the `../../specs/` folder.