Commit f16a8592 authored by bojanz's avatar bojanz
Browse files

Update the README to clarify that we only have a single library dependency.

parent 59e0c973
...@@ -4,11 +4,11 @@ Provides functionality for storing, validating and displaying international post ...@@ -4,11 +4,11 @@ Provides functionality for storing, validating and displaying international post
The Drupal 8 heir to the addressfield module, powered by the [commerceguys/addressing](https://github.com/commerceguys/addressing) library. The Drupal 8 heir to the addressfield module, powered by the [commerceguys/addressing](https://github.com/commerceguys/addressing) library.
## Installation ## Installation
Since the module requires external libraries, Composer or Ludwig must be used. Since the module requires an external library, Composer or Ludwig must be used.
### Composer ### Composer
If your site is [managed via Composer](https://www.drupal.org/node/2718229), use Composer to If your site is [managed via Composer](https://www.drupal.org/node/2718229), use Composer to
download the module, which will also download the required libraries: download the module, which will also download the required library:
```sh ```sh
composer require "drupal/address ~1.0" composer require "drupal/address ~1.0"
``` ```
...@@ -17,15 +17,15 @@ Use ```composer update drupal/address --with-dependencies``` to update to a new ...@@ -17,15 +17,15 @@ Use ```composer update drupal/address --with-dependencies``` to update to a new
### Ludwig ### Ludwig
Otherwise, download and install [Ludwig](https://www.drupal.org/project/ludwig) which will allow you Otherwise, download and install [Ludwig](https://www.drupal.org/project/ludwig) which will allow you
to download the libraries separately: to download the library separately:
1) Download Address into your modules folder. 1) Download Address into your modules folder.
2) Use one of Ludwig's methods to download libraries: 2) Use one of Ludwig's methods to download the library:
a) Run the ```ludwig:download``` Drupal Console command or the ```ludwig-download``` Drush command. a) Run the ```ludwig:download``` Drupal Console command or the ```ludwig-download``` Drush command.
b) Go to ```/admin/reports/packages``` and download each library manually, then place them under address/lib as specified. b) Go to ```/admin/reports/packages``` and download the library manually, then place it under address/lib as specified.
3) Enable Address. 3) Enable Address.
Note that when using Ludwig, updating the module will require re-downloading the libraries. Note that when using Ludwig, updating the module will require re-downloading the library.
Composer is recommended whenever possible. Composer is recommended whenever possible.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment