aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 04b711f..50f2ccb 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,17 @@ NorgKit is a Swift parser and library for `.norg` / [Neorg](https://github.com/n
* Types are `Hashable` and `Codable` for caching and serialization.
* Reasonably Fast.
+## Installation
+
+Add the package with Swift Package Manager:
+
+```swift
+.package(url: "https://git.r.bdr.sh/norg-ui", from: "1.0.0"),
+```
+
+…or the xcode package manager, and depend on the `NorgKit` product from your
+target.
+
## Usage
`NorgParser.parse` outputs a flat list of blocks you can iterate over.