Skip to content

Commit 73f2154

Browse files
author
Simon Pilkington
committed
Added Getting Started to the README.
1 parent 52968cd commit 73f2154

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,24 @@
1717

1818
SmokeDynamoDB is a library to make it easy to use DynamoDB from Swift-based applications, with a particular focus on usage with polymorphic database tables (tables that don't have a single schema for all rows.
1919

20+
# Getting Started
21+
22+
## Step 1: Add the SmokeDynamoDB dependency
23+
24+
SmokeDynamoDB uses the Swift Package Manager. To use the framework, add the following dependency
25+
to your Package.swift-
26+
27+
```swift
28+
dependencies: [
29+
.package(url: "https://github.com/amzn/smoke-dynamodb.git", .upToNextMajor(from: "1.0.0"))
30+
]
31+
32+
33+
.target(
34+
name: ...,
35+
dependencies: [..., "SmokeDynamoDB"]),
36+
```
37+
2038
# Basic Usage
2139

2240
## Naming Schema

0 commit comments

Comments
 (0)