diff --git a/README.md b/README.md index bb33e4c..917d1ad 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ Harmonica =========
+ 
@@ -9,9 +10,20 @@ Harmonica
A simple, efficient spring animation library for smooth, natural motion.
-
+
-Harmonica is framework-agnostic and works well in 2D and 3D contexts.
+It even works well on the command line.
+
+
+
+[examples]: https://github.com/charmbracelet/harmonica/tree/master/examples
+[docs]: https://pkg.go.dev/github.com/charmbracelet/harmonica?tab=doc
+
+## Usage
+
+Harmonica is framework-agnostic and works well in 2D and 3D contexts. Simply
+call [`NewSpring`][newspring] with your settings to initialize and
+[`Update`][update] on each frame to animate.
```go
import "github.com/charmbracelet/harmonica"
@@ -37,18 +49,14 @@ for {
}
```
-It even works well on the command line.
-
-
-
For details, see the [examples][examples] and the [docs][docs].
-[examples]: https://github.com/charmbracelet/harmonica/tree/master/examples
-[docs]: https://pkg.go.dev/github.com/charmbracelet/harmonica?tab=doc
+[newspring]: https://pkg.go.dev/github.com/charmbracelet/harmonica#NewSpring
+[update]: https://pkg.go.dev/github.com/charmbracelet/harmonica#Update
## Settings
-[`NewSpring`](https://pkg.go.dev/github.com/charmbracelet/harmonica#NewSpring) takes three values:
+[`NewSpring`][newspring] takes three values:
* **Time Delta:** the time step to operate on. Game engines typically provide
a way to determine the time delta, however if that's not available you can