Skip to content

Commit

Permalink
Add Installation section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
sharplet committed Aug 24, 2020
1 parent 124a8a5 commit 04b164b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
Binary file added Documentation/Images/add-package-dependency.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

An implementation of the Model-View-ViewModel (MVVM) pattern using Combine.

- [Example](#example)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Bindings](#bindings)
- [Contributing](#contributing)
- [About](#about)

## Example
## Getting Started

### Step 1: A view model is class that conforms to `ObservableObject`

Expand Down Expand Up @@ -74,6 +75,14 @@ final class CounterViewController: UIViewController, ViewModelObserver {
}
```

## Installation

CombineViewModel is distributed via Swift Package Manager. To add it to your
Xcode project, navigate to File > Add Package Dependency…, paste in the
repository URL, and follow the prompts.

<img alt="Screen capture of Xcode on macOS Big Sur, with the Add Package Dependency menu item highlighted" width="945" src="/Documentation/Images/add-package-dependency.png">

## Bindings

CombineViewModel also provides the complementary [`Bindings`](/Sources/Bindings)
Expand Down

0 comments on commit 04b164b

Please sign in to comment.