Browse Source

Add documentation for resolve-dependencies

Joshua Gigg 11 years ago
parent
commit
6c96bf6ae6
1 changed files with 16 additions and 0 deletions
  1. 16 0
      doc/articles/handling-private-packages-with-satis.md

+ 16 - 0
doc/articles/handling-private-packages-with-satis.md

@@ -170,3 +170,19 @@ bucket or on a CDN host. A CDN would drastically improve download times and ther
 
 Example: A `prefix-url` of `http://my-bucket.s3.amazonaws.com` (and `directory` set to `dist`) creates download URLs
 which look like the following: `http://my-bucket.s3.amazonaws.com/dist/vendor-package-version-ref.zip`.
+
+
+### Resolving dependencies
+
+It is possible to make satis automatically resolve and add all dependencies for your projects. This can be used
+with the Downloads functionality to have a complete local mirror of packages. Just add the following
+to your `satis.json`:
+
+```json
+{
+    "require-dependencies": true,
+}
+```
+
+When searching for packages, satis will attempt to resolve all the required packages from the listed repositories.
+Therefore, if you are requiring a package from Packagist, you will need to define it in your `satis.json`.