Skip to content

Commit

Permalink
Update docs with new version
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenkuhn committed Dec 18, 2019
1 parent a657ec0 commit 62cbc9a
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 17 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Install-Package Sknet.InRuleGitStorage -IncludePrerelease
```

```batch
dotnet add package Sknet.InRuleGitStorage --version 0.2.1
dotnet add package Sknet.InRuleGitStorage --version 0.2.2
```

## Basic example
Expand Down Expand Up @@ -57,13 +57,13 @@ InRuleGitRepository.Clone(
// Get a new instance of your local InRule Git repository
using (var repo = InRuleGitRepository.Open("/path/to/local/repo"))
{
// Create a local branch that is tracked to the remote "v0.2.1" branch
repo.CreateTrackedBranch("v0.2.1", "origin");
// Create a local branch that is tracked to the remote "v0.2.2" branch
repo.CreateTrackedBranch("v0.2.2", "origin");

// Switch the current branch to the newly created tracked branch
repo.Checkout("v0.2.1");
repo.Checkout("v0.2.2");

// Create a local branch from the "v0.2.1" branch
// Create a local branch from the "v0.2.2" branch
repo.CreateBranch("invoice-date-field");

// Switch the current branch to the newly created local branch
Expand All @@ -76,13 +76,13 @@ using (var repo = InRuleGitRepository.Open("/path/to/local/repo"))
repo.Commit(ruleApp, "Add invoice date field");

// Switch back to the previous branch that does not have the field change
repo.Checkout("v0.2.1");
repo.Checkout("v0.2.2");

// Merge the invoice date field change into the current branch
repo.Merge("invoice-date-field");

// Delete the original branch containing the invoice date field change since the
// change now exists in the "v0.2.1" branch
// change now exists in the "v0.2.2" branch
repo.RemoveBranch("invoice-date-field");
}
```
2 changes: 1 addition & 1 deletion docs/coverpage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![logo](assets/img/logo.svg ':size=200')

# InRuleGitStorage<small>0.2.1</small>
# InRuleGitStorage<small>0.2.2</small>

>Store and manage your <a href="https://www.inrule.com/" style="text-decoration: underline rgba(51, 51, 51, 0.2);">InRule</a>® business rules in a Git repository.
Expand Down
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ InRuleGitStorage is a NuGet package that can be installed using a package instal
## Package Manager

```powershell
PM> Install-Package Sknet.InRuleGitStorage -Version 0.2.1
PM> Install-Package Sknet.InRuleGitStorage -Version 0.2.2
```

## .NET CLI

```batch
dotnet add package Sknet.InRuleGitStorage --version 0.2.1
dotnet add package Sknet.InRuleGitStorage --version 0.2.2
```

## Package Reference

```xml
<PackageReference Include="Sknet.InRuleGitStorage" Version="0.2.1" />
<PackageReference Include="Sknet.InRuleGitStorage" Version="0.2.2" />
```
16 changes: 10 additions & 6 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ InRuleGitRepository.Clone(
// Get a new instance of your local InRule Git repository
using (var repo = InRuleGitRepository.Open("/path/to/local/repo"))
{
// Create a local branch that is tracked to the remote "v0.2.1" branch
repo.CreateBranch("v0.2.1", "origin");
// Create a local branch that is tracked to the remote "v0.2.2" branch
repo.CreateBranch("v0.2.2", "origin");

// Switch the current branch to the newly created tracked branch
repo.Checkout("v0.2.1");
repo.Checkout("v0.2.2");

// Create a local branch from the "v0.2.1" branch
// Create a local branch from the "v0.2.2" branch
repo.CreateBranch("invoice-date-field");

// Switch the current branch to the newly created local branch
Expand All @@ -65,14 +65,18 @@ using (var repo = InRuleGitRepository.Open("/path/to/local/repo"))
repo.Commit(ruleApp, "Add invoice date field");

// Switch back to the previous branch that does not have the field change
repo.Checkout("v0.2.1");
repo.Checkout("v0.2.2");

// Merge the invoice date field change into the current branch
repo.Merge("invoice-date-field");

// Delete the original branch containing the invoice date field change since the
// change now exists in the "v0.2.1" branch
// change now exists in the "v0.2.2" branch
repo.RemoveBranch("invoice-date-field");

// Push the changes in the current branch to the remote repository (commented out
// to show an example; you will not have access to update the public samples repo)
// repo.Push();
}
```

Expand Down

0 comments on commit 62cbc9a

Please sign in to comment.