Permalink
Browse files

Suggest explicit check for PrivateWagon as temporary workaround.

  • Loading branch information...
technomancy committed Dec 21, 2011
1 parent 2bb6246 commit 691e77c3e427f8f9fd3576efd3accb6240ee5ea6
Showing with 16 additions and 3 deletions.
  1. +16 −3 README.md
View
@@ -1,8 +1,9 @@
# s3-wagon-private
-Deploy artifacts to private S3 repositories. Designed to be used from
-[Leiningen](https://github.com/technomancy/leiningen), but should be
-usable in other contexts by deploying to repositories at "s3p://" URLs.
+Deploy and consume artifacts in private S3 repositories. Designed to
+be used from [Leiningen](https://github.com/technomancy/leiningen),
+but should be usable in other contexts by deploying to repositories at
+"s3p://" URLs.
## Usage
@@ -20,6 +21,18 @@ Add the repositories listing to `project.clj`:
"snapshots" "s3p://mybucket/snapshots/"}
```
+Future versions of Leiningen will allow you to declare the plugin
+dependency in `project.clj`, but for the time being you may want to
+include this warning at the bottom of `project.clj` so you will get
+more helpful error messages when it's missing:
+
+```clj
+(try (resolve 's3.wagon.private.PrivateWagon)
+ (catch java.lang.ClassNotFoundException _
+ (println "WARNING: You appear to be missing s3-private-wagon.")
+ (println "To install it: lein plugin install s3-private-wagon 1.0.0")))
+```
+
You should keep your S3 credentials in `~/.lein/init.clj`:
```clj

0 comments on commit 691e77c

Please sign in to comment.