Update readme

Author: kimdv

Documentation/README.md

@@ -0,0 +1 @@
+# Documentation

Documentation/SwiftSyntax/README.md

@@ -0,0 +1 @@
+# Swift Syntax

Documentation/SwiftSyntaxBuilder/README.md

@@ -0,0 +1,70 @@
+# Swift Syntax Builder
+
+**Swift Syntax Builder** is an open-source package for generating Swift code in a declarative way.
+
+> Note: SwiftSyntaxBuilder is still in development, and the API is not guaranteed to
+> be stable. It's subject to change without warning.
+
+```swift
+import SwiftSyntaxBuilder
+
+let source = SourceFile {
+  ImportDecl(path: "Foundation")
+  ImportDecl(path: "UIKit")
+  ClassDecl(classOrActorKeyword: .class, identifier: "SomeViewController", membersBuilder: {
+    VariableDecl(.let, name: "tableView", type: "UITableView")
+  })
+}
+
+let syntax = source.buildSyntax(format: Format())
+
+var text = ""
+syntax.write(to: &text)
+
+print(text)
+```
+
+prints:
+
+```swift
+import Foundation
+import UIKit
+class SomeViewController{
+    let tableView: UITableView
+}
+```
+
+## Usage
+
+### Declare SwiftPM dependency with release tag
+
+Add this repository to the `Package.swift` manifest of your project:
+
+```swift
+// swift-tools-version:5.3
+import PackageDescription
+
+let package = Package(
+  name: "MyTool",
+  dependencies: [
+    .package(name: "SwiftSyntax", url: "https://github.com/apple/swift-syntax.git", .exact("<#Specify Release tag#>")),
+  ],
+  targets: [
+    .target(name: "MyTool", dependencies: ["SwiftSyntaxBuilder"]),
+  ]
+)
+```
+
+Replace `<#Specify Release tag#>` by the version of SwiftSyntaxBuilder that you want to use. See this following [table](https://github.com/apple/swift-syntax#declare-swiftpm-dependency-with-release-tag) for mapping details.
+
+Then, import `SwiftSyntaxBuilder` in your Swift code.
+
+Note that SwiftSyntaxBuilder has limited support for pretty-printing code. We generally suggest running a formatter like [swift-format](https://github.com/apple/swift-format) on the generated code.
+
+### Reporting Issues
+
+If you should hit any issues while using SwiftSyntaxBuilder, we appreciate bug reports on [bugs.swift.org](https://bugs.swift.org) in the [SwiftSyntax component](https://bugs.swift.org/issues/?jql=component%20%3D%20SwiftSyntax).
+
+## License
+
+Please see [LICENSE](https://github.com/apple/swift-syntax#license) for more information.

Documentation/SwiftSyntaxParser/README.md

@@ -0,0 +1 @@
+# Swift Syntax Parser

Examples/README.md

@@ -0,0 +1 @@
+# Examples

Examples/SwiftSyntax/AddOneToIntegerLiterals.swift

@@ -0,0 +1,32 @@
+import SwiftSyntax
+import Foundation
+
+/// AddOneToIntegerLiterals will visit each token in the Syntax tree, and
+/// (if it is an integer literal token) add 1 to the integer and return the
+/// new integer literal token.
+class AddOneToIntegerLiterals: SyntaxRewriter {
+  override func visit(_ token: TokenSyntax) -> Syntax {
+    // Only transform integer literals.
+    guard case .integerLiteral(let text) = token.tokenKind else {
+      return Syntax(token)
+    }
+
+    // Remove underscores from the original text.
+    let integerText = String(text.filter { ("0"..."9").contains($0) })
+
+    // Parse out the integer.
+    let int = Int(integerText)!
+
+    // Create a new integer literal token with `int + 1` as its text.
+    let newIntegerLiteralToken = token.withKind(.integerLiteral("\(int + 1)"))
+    
+    // Return the new integer literal.
+    return Syntax(newIntegerLiteralToken)
+  }
+}
+
+let file = CommandLine.arguments[1]
+let url = URL(fileURLWithPath: file)
+let sourceFile = try SyntaxParser.parse(url)
+let incremented = AddOneToIntegerLiterals().visit(sourceFile)
+print(incremented)

Examples/SwiftSyntax/README.md

@@ -0,0 +1,52 @@
+# Swift Syntax
+
+This is a program that adds 1 to every integer literal in a Swift file.
+
+```swift
+import SwiftSyntax
+import Foundation
+
+/// AddOneToIntegerLiterals will visit each token in the Syntax tree, and
+/// (if it is an integer literal token) add 1 to the integer and return the
+/// new integer literal token.
+class AddOneToIntegerLiterals: SyntaxRewriter {
+  override func visit(_ token: TokenSyntax) -> Syntax {
+    // Only transform integer literals.
+    guard case .integerLiteral(let text) = token.tokenKind else {
+      return Syntax(token)
+    }
+
+    // Remove underscores from the original text.
+    let integerText = String(text.filter { ("0"..."9").contains($0) })
+
+    // Parse out the integer.
+    let int = Int(integerText)!
+
+    // Create a new integer literal token with `int + 1` as its text.
+    let newIntegerLiteralToken = token.withKind(.integerLiteral("\(int + 1)"))
+    
+    // Return the new integer literal.
+    return Syntax(newIntegerLiteralToken)
+  }
+}
+
+let file = CommandLine.arguments[1]
+let url = URL(fileURLWithPath: file)
+let sourceFile = try SyntaxParser.parse(url)
+let incremented = AddOneToIntegerLiterals().visit(sourceFile)
+print(incremented)
+```
+
+This example turns this:
+
+```swift
+let x = 2
+let y = 3_000
+```
+
+into:
+
+```swift
+let x = 3
+let y = 3001
+```

Examples/SwiftSyntaxBuilder/SwiftSyntaxBuilder.md

@@ -0,0 +1,70 @@
+# Swift Syntax Builder
+
+**Swift Syntax Builder** is an open-source package for generating Swift code in a declarative way.
+
+> Note: SwiftSyntaxBuilder is still in development, and the API is not guaranteed to
+> be stable. It's subject to change without warning.
+
+```swift
+import SwiftSyntaxBuilder
+
+let source = SourceFile {
+  ImportDecl(path: "Foundation")
+  ImportDecl(path: "UIKit")
+  ClassDecl(classOrActorKeyword: .class, identifier: "SomeViewController", membersBuilder: {
+    VariableDecl(.let, name: "tableView", type: "UITableView")
+  })
+}
+
+let syntax = source.buildSyntax(format: Format())
+
+var text = ""
+syntax.write(to: &text)
+
+print(text)
+```
+
+prints:
+
+```swift
+import Foundation
+import UIKit
+class SomeViewController{
+    let tableView: UITableView
+}
+```
+
+## Usage
+
+### Declare SwiftPM dependency with release tag
+
+Add this repository to the `Package.swift` manifest of your project:
+
+```swift
+// swift-tools-version:5.3
+import PackageDescription
+
+let package = Package(
+  name: "MyTool",
+  dependencies: [
+    .package(name: "SwiftSyntax", url: "https://github.com/apple/swift-syntax.git", .exact("<#Specify Release tag#>")),
+  ],
+  targets: [
+    .target(name: "MyTool", dependencies: ["SwiftSyntaxBuilder"]),
+  ]
+)
+```
+
+Replace `<#Specify Release tag#>` by the version of SwiftSyntaxBuilder that you want to use. See this following [table](https://github.com/apple/swift-syntax#declare-swiftpm-dependency-with-release-tag) for mapping details.
+
+Then, import `SwiftSyntaxBuilder` in your Swift code.
+
+Note that SwiftSyntaxBuilder has limited support for pretty-printing code. We generally suggest running a formatter like [swift-format](https://github.com/apple/swift-format) on the generated code.
+
+### Reporting Issues
+
+If you should hit any issues while using SwiftSyntaxBuilder, we appreciate bug reports on [bugs.swift.org](https://bugs.swift.org) in the [SwiftSyntax component](https://bugs.swift.org/issues/?jql=component%20%3D%20SwiftSyntax).
+
+## License
+
+Please see [LICENSE](https://github.com/apple/swift-syntax#license) for more information.

Examples/SwiftSyntaxParser/SwiftSyntaxBuilderParser.md

@@ -0,0 +1 @@
+# Swift Syntax Parser