You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by bc...@apache.org on 2023/10/18 01:31:24 UTC
[beam-swift] 06/10: Added README
This is an automated email from the ASF dual-hosted git repository.
bce pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/beam-swift.git
commit 1c32ef777b1bdea8905cd275a9a90f111e6c01f6
Author: Byron Ellis <by...@google.com>
AuthorDate: Wed Oct 4 11:29:41 2023 -0700
Added README
---
README.md | 40 ++++++++++++++++++++++++++++++++--------
1 file changed, 32 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index d101413..4a18f05 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,32 @@
-//
-// File.swift
-// beam-swift
-//
-// Created by Byron Ellis on 10/4/23.
-//
-
-import Foundation
+# Apache Beam Swift SDK
+
+Provides [Apache Beam][0] for Swift.
+
+## Usage
+
+Add the package dependency in your `Package.swift`:
+
+```swift
+.package(
+ url: "https://github.com/apache/beam-swift",
+ .branch("main")
+)
+```
+
+Next, in your target add `ApacheBeam` to your dependencies:
+
+```swift
+.target(name: "MyPipeline",dependencies:[
+ .product(name:"ApacheBeam",package:"beam-swift"),
+],
+```
+
+## Documentation
+
+[0]: https://beam.apache.org
+
+
+
+
+
+