You are here

function commerce_usps_help in Commerce USPS 8

Implements hook_help().

File

./commerce_usps.module, line 13
Contains commerce_usps.module.

Code

function commerce_usps_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {

    // Main module help for the commerce_usps module.
    case 'help.page.commerce_usps':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('This module provides USPS shipping calculations for Drupal Commerce by extending the Drupal Commerce Shipping API. This module should be used by those that want to provide dynamic USPS shipping rates on their US based Drupal Commerce sites.') . '</p>';
      $output .= '<h3>' . t('Configuration') . '</h3>';
      $output .= '<dt>' . t('1. Go to /admin/commerce/config/shipping-methods/add') . '</dt>';
      $output .= '<dt>' . t('2. Select "USPS" as the Plugin') . '</dt>';
      $output .= '<dt>' . t('3. Enter the USPS API details') . '</dt>';
      $output .= '<dt>' . t('4. Select a default package type') . '</dt>';
      $output .= '<dt>' . t('5. Select all the shipping services that should be disabled') . '</dt>';
      $output .= '<dt>' . t('6. Fill out any of the optional configs and save configuration') . '</dt>';
      $output .= '<dt>' . t('7. Add a product to cart and checkout') . '</dt>';
      $output .= '<dt>' . t('8. Enter your shipping address and click on "Calculate Shipping"') . '</dt>';
      $output .= '<dt>' . t('9. The estimated rates retrieved from USPS will now show up for the order') . '</dt>';
      return $output;
  }
}