Commit 1dac9972 authored by bojanz's avatar bojanz
Browse files

Issue #2906334 by bojanz: Document the Ludwig installation method

parent 2b0c7455
Address
=======
[![Build Status](https://travis-ci.org/bojanz/address.svg?branch=8.x-1.x)](https://travis-ci.org/bojanz/address)
# Address
Provides functionality for storing, validating and displaying international postal addresses.
The Drupal 8 heir to the addressfield module, powered by the [commerceguys/addressing](https://github.com/commerceguys/addressing) library.
Installation
-------------
This module needs to be installed via Composer, which will download the required libraries.
1. Add the Drupal Packagist repository
## Installation
Since the module requires external libraries, Composer or Ludwig must be used.
### Composer
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:
```sh
composer config repositories.drupal composer https://packages.drupal.org/8
composer require "drupal/address ~1.0"
```
This allows Composer to find Address and the other Drupal modules.
~1.0 downloads the latest release, use 1.x-dev to get the -dev release instead.
Use ```composer update drupal/address --with-dependencies``` to update to a new release.
2. Download Address
### Ludwig
Otherwise, download and install [Ludwig](https://www.drupal.org/project/ludwig) which will allow you
to download the libraries separately:
1) Download Address into your modules folder.
2) Use one of Ludwig's methods to download libraries:
```sh
composer require "drupal/address ~1.0"
```
This will download the latest release of Address.
Use 1.x-dev instead of ~1.0 to get the -dev release instead.
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.
3) Enable Address.
See https://www.drupal.org/node/2404989 for more information.
Note that when using Ludwig, updating the module will require re-downloading the libraries.
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