Update README: recommend nicklockwood/SwiftFormat

README.md

@@ -1,30 +1,67 @@
-SwiftFormat
-==============
+# SwiftFormat
 
-Python script for auto formatting Swift code, similar to Clang format.
- 
- Current status: Gonna rewrite this to Swift.
+> **Looking for a Swift formatter? Use [nicklockwood/SwiftFormat](https://github.com/nicklockwood/SwiftFormat) instead.**
+>
+> This repository is an old, unmaintained prototype. The community standard for Swift formatting is **nicklockwood/SwiftFormat** — see the recommendation below.
 
-## Usage
+---
+
+## Recommended Tool: nicklockwood/SwiftFormat
+
+**[https://github.com/nicklockwood/SwiftFormat](https://github.com/nicklockwood/SwiftFormat)**
+
+nicklockwood/SwiftFormat is the actively maintained, feature-rich Swift formatter used widely across the Swift community. It offers:
+
+- **Command-line tool (CLI)** — format Swift files from the terminal, easy to integrate into CI/CD pipelines
+- **Xcode source editor extension** — format code directly inside Xcode with a keyboard shortcut
+- **Swift Package Manager (SPM) plugin** — integrate formatting as a build tool plugin in your Swift packages
+- **Rich rule set** — 50+ configurable formatting rules covering indentation, spacing, braces, imports, and more
+- **`.swiftformat` config file** — per-project configuration checked into source control
+- **Actively maintained** — regular releases, broad community adoption, and Swift version support
+
+### Installation
 
-#### auto format a file
 ```bash
-Usage: 
---file [FILE] The file to format
---output [FILE] The file to write the formatted output to
+# Homebrew
+brew install swiftformat
+
+# Mint
+mint install nicklockwood/SwiftFormat
+
+# Swift Package Manager plugin — add to Package.swift
+.package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.54.0")
+```
+
+---
+
+## About this repo
+
+This repository was an early prototype (circa 2015) — a Python script that applied basic auto-formatting to Swift code, similar to `clang-format`. It was a proof-of-concept with a small set of indentation rules and a simple test harness.
+
+The original README noted: *"Gonna rewrite this to Swift."* — that rewrite never happened here, but nicklockwood/SwiftFormat became exactly that and much more. This repo is no longer maintained.
+
+---
 
+## Original Content (Historical)
+
+### Usage
+
+```bash
+# auto format a file
 python format.py --file inputfilename.swift --output outputfilename.swift
 ```
-### Demo
 
-![Demo script run](https://raw.githubusercontent.com/haaakon/SwiftFormat/b746a3d8e7e067faecc8997fc4b9acd17b5ecb5f/swiftformat.gif)
+**Options:**
+- `--file [FILE]` — the file to format
+- `--output [FILE]` — the file to write the formatted output to
 
-### Contributing
+### Demo
 
-All contributions are more than welcome, suggestions on how to move forward is appreciated.
+![Demo script run](https://raw.githubusercontent.com/haaakon/SwiftFormat/b746a3d8e7e067faecc8997fc4b9acd17b5ecb5f/swiftformat.gif)
 
 ### Test format
-Put source code to be formatted above @@@, and under put the correct way it should be formatted after running the format script.
+
+Put source code to be formatted above `@@@`, and below put the correct expected output after running the format script.
 
 ```swift
 class test() {{var str = "teststr" }}
@@ -36,9 +73,10 @@ class test() {
 }
 ```
 
-For each rule thats added, add a test file that shows how it should format correctly. The test checks that all files are formatted correctly as shown under the @@@ in their file.
+For each rule added, include a test file showing correct formatting. The test checks that all files are formatted as shown below `@@@`.
 
 #### Run tests
+
 ```bash
 python tests.py
 TEST OK for python/SwiftFormatter/testCases/indentation/indentTest.test
@@ -48,14 +86,16 @@ TEST OK for python/SwiftFormatter/testCases/indentation/prefixedSpaces.test
 TEST OK for python/SwiftFormatter/testCases/indentation/twoCurly.test
 ```
 
+### TODO (original)
 
-
-### TODO
-- Add alot more formatting rules
-- be able to turn rules on/off
-- add a plugin for xcode
+- Add a lot more formatting rules
+- Be able to turn rules on/off
+- Add a plugin for Xcode
 
 ## License
+
 MIT
-### Author 
-Håkon Bogen hakon.bogen@gmail.com
+
+### Author
+
+Håkon Bogen — hakon.bogen@gmail.com