Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lukaskubanek/LoremSwiftum

A lightweight lorem ipsum generator for Swift
https://github.com/lukaskubanek/LoremSwiftum

ios lorem-ipsum swift

Last synced: 3 months ago
JSON representation

A lightweight lorem ipsum generator for Swift

Awesome Lists containing this project

README

        

# LoremSwiftum






Swift 4.0+


Swift Package Manager


Carthage


License: MIT


Twitter: @lukaskubanek

LoremSwiftum is a lightweight lorem ipsum generator library for Swift. It supports generating random words, sentences, paragraphs, titles, names, email addresses, URLs, and tweets. Initially, this library was created as a Swift port of [LoremIpsum](https://github.com/lukaskubanek/LoremIpsum) written in Objective-C.

## Requirements

- Swift 4.0+
- Xcode 9.2+
- iOS 8.0+ / macOS 10.10+

*The Xcode and OS requirements apply only when the library is integrated as a framework or via the Xcode project.*

## Installation

### Swift Package Manager

To install LoremSwiftum using the [Swift Package Manager](https://swift.org/package-manager/), add it as a dependency into your `Package.swift` file:

```swift
let package = Package(
...
dependencies: [
.package(url: "https://github.com/lukaskubanek/LoremSwiftum.git", from: "2.2.1")
],
...
)
```

### Carthage

To install LoremSwiftum using [Carthage](https://github.com/Carthage/Carthage), add it as a dependency into your `Cartfile`:

```plain
github "lukaskubanek/LoremSwiftum"
```

Then drag either the `LoremSwiftum.xcodeproj` or the `LoremSwiftum.framework` into your Xcode project/workspace and link your target against the `LoremSwiftum.framework`. Make sure that the framework [gets copied](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application) to your application bundle.

### Git Submodules

You can also install LoremSwiftum via [Git submodules](http://git-scm.com/book/en/v2/Git-Tools-Submodules) and integrate the project `LoremSwiftum.xcodeproj` from the submodule directly into your Xcode workspace.

## Usage

```swift
import LoremSwiftum

Lorem.word
// => One random word

Lorem.words(3)
// => Three random words

Lorem.sentence
// => One random sentence

Lorem.sentences(3)
// => Three random sentences

Lorem.paragraph
// => One random paragraph

Lorem.paragraphs(3)
// => Three random paragraphs

Lorem.title
// => A random title

Lorem.firstName
// => A random first name

Lorem.lastName
// => A random last name

Lorem.fullName
// => A random full name

Lorem.emailAddress
// => A random email address

Lorem.url
// => A random URL

Lorem.shortTweet
// => A random short tweet

Lorem.tweet
// => A random long tweet
```