[Docs] Clarity in README (#1)

1 file changed
tree: 80b6a8a0df7a845265741a1ce947b36a707865fb
  1. examples/
  2. src/
  3. tests/
  4. .clang-format
  5. .codecov.yml
  6. .gitignore
  7. .jazzy.yaml
  8. .travis.yml
  9. AUTHORS
  10. CHANGELOG.md
  11. CONTRIBUTING.md
  12. LICENSE
  13. MDFFontDiskLoader.podspec
  14. README.md
README.md

#FontDiskLoader

Registers a single custom font asset from disk

Material Design Specifications

Overview

Font Disk Loader lazily registers custom fonts and caches them even if they are not included in the app's info.plist.

Installation

Requirements

  • Xcode 7.0 or higher.
  • iOS SDK version 7.0 or higher.

Installation with CocoaPods

To add this component to your Xcode project using CocoaPods, add the following to your Podfile:

pod 'MDFFontDiskLoader'

Then, run the following command:

pod install

Importing

Before using Font Disk Loader, you'll need to import it:

Objective-C

#import "MaterialFontDiskLoader.h"

Swift

import MDFFontDiskLoader

Usage

Make sure to add your font (or the bundle it is in) to your app target. The FontDiskLoader will lazy register the font using a CoreText API so adding the font to your info.plist is not necessary. All you need to do is initialize the loader with the font name and url of the file and ask for the font.

Code snippets

Objective-C

  MDFFontDiskLoader *fontDiskLoader =
      [[MDFFontDiskLoader alloc] initWithFontName:nameOfFontInFile fontURL:fontURLOnDisk];
  UIFont *font = [fontDiskLoader fontOfSize:16];

Swift

    let fontLoader = MDFFontDiskLoader.init(fontName: nameOfFontInFile, fontURL: fontURLOnDisk);
    let myFont:UIFont = fontLoader.fontOfSize(16)!;