leaf package

This commit is contained in:
tanner0101 2017-04-12 17:07:03 +02:00
parent 3d5ff55514
commit 37092ddb20
1 changed files with 43 additions and 0 deletions

43
2.0/docs/leaf/package.md Normal file
View File

@ -0,0 +1,43 @@
# Using Leaf
This section outlines how to import the Leaf package both with or without a Vapor project.
## With Vapor
The easiest way to use Leaf with Vapor is to include the Leaf provider.
```swift
import PackageDescription
let package = Package(
name: "Project",
dependencies: [
.Package(url: "https://github.com/vapor/vapor.git", majorVersion: 2),
.Package(url: "https://github.com/vapor/leaf-provider.git", majorVersion: 1)
],
exclude: [ ... ]
)
```
The Leaf provider package adds Leaf to your project and adds some additional, Vapor-specific conveniences like `drop.stem()`.
Use `import LeafProvider`.
## Just Leaf
At the core of the Leaf provider is a fast, pure Swift templating engine. You can use it with any of your Swift packages or server-side Swift applications.
```swift
import PackageDescription
let package = Package(
name: "Project",
dependencies: [
...
.Package(url: "https://github.com/vapor/leaf.git", majorVersion: 2)
],
exclude: [ ... ]
)
```
Use `import Leaf` to access the `Leaf.Stem` class.