Skip to content

Commit fed4e24

Browse files
author
Anouar Hassine
committed
Updating readme file
1 parent f16e290 commit fed4e24

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
[![](http://slack.xcomponent.com/badge.svg)](http://slack.xcomponent.com/)
2+
[![ReactiveXComponent.Net Nuget](https://img.shields.io/nuget/v/ReactiveXComponent.Net.svg)](https://www.nuget.org/packages/ReactiveXComponent.Net) [![ReactiveXComponent.Net Downloads](https://img.shields.io/nuget/dt/ReactiveXComponent.Net.svg)](https://www.nuget.org/packages/ReactiveXComponent.Net) [![](http://slack.xcomponent.com/badge.svg)](http://slack.xcomponent.com/)
33

44
# .Net Reactive XComponent API
55

@@ -8,7 +8,6 @@
88
ReactiveXComponent.Net is a .Net client API that allows you to interact with microservices generated with XComponent software.
99

1010
## Install
11-
[![ReactiveXComponent.Net Nuget](https://img.shields.io/nuget/v/ReactiveXComponent.Net.svg)](https://www.nuget.org/packages/ReactiveXComponent.Net) [![ReactiveXComponent.Net Downloads](https://img.shields.io/nuget/dt/ReactiveXComponent.Net.svg)](https://www.nuget.org/packages/ReactiveXComponent.Net)
1211

1312
Use Nuget to install the latest version of the API:
1413
``` nuget install ReactiveXComponent.Net -Pre```
@@ -17,24 +16,21 @@ Use Nuget to install the latest version of the API:
1716

1817
Usage example of ReactiveXComponent.Net API
1918
```csharp
20-
// All the info we need is in the xcApi file..
21-
var xcApiStream = new FileStream("HelloWorld.xcApi", FileMode.Open);
22-
23-
// Get a XComponentApi..
24-
IXComponentApi xcApi = XComponentApi.CreateFromXCApi(xcApiStream);
19+
// All the info we need is in the xcApi file. Get a XComponentApi..
20+
IXComponentApi xcApi = XComponentApi.CreateFromXCApi(@".\HelloWorld.xcApi");
2521

2622
// Create a session..
27-
using (IXCSession _xcSession = xcApi.CreateSession())
23+
using (IXCSession xcSession = xcApi.CreateSession())
2824
{
2925
var componentName = "HelloWorld";
3026
var helloWorldManagerStateMachineName = "HelloWorldManager";
3127
var helloWorldResponseStateMachineCode = 1837059171;
3228

3329
// Create a subscriber..
34-
var subscriber = _xcSession.CreateSubscriber(componentName);
30+
var subscriber = xcSession.CreateSubscriber(componentName);
3531

3632
// Create a publisher..
37-
var publisher = _xcSession.CreatePublisher(componentName);
33+
var publisher = xcSession.CreatePublisher(componentName);
3834

3935
// Need to call subscribe for the state machine we are interested in..
4036
subscriber.Subscribe(helloWorldManagerStateMachineName, arg => {});
@@ -66,13 +62,14 @@ using (IXCSession _xcSession = xcApi.CreateSession())
6662
## Build from source
6763
Download the source code and execute the following command in a PowerShell:
6864
```
69-
.\build.ps1 -Target <target> -ScriptArgs '-buildConfiguration="<build_configuration>" -buildVersion="<build_version>"'
70-
```
71-
Here is an exmaple:
72-
```
73-
.\build.ps1 -Target Build -ScriptArgs '-buildConfiguration="Debug" -buildVersion="1.0.0.1"'
65+
.\build.ps1 -Target All
7466
```
67+
That would build the source code run the tests and create a Nuget package under the *nuget* folder.
7568

69+
The complete command that contains all the possible parameters is as follows:
70+
```
71+
.\build.ps1 -Target <Target> --buildConfiguration=<build_config> --buildVersion=<build_version> --setAssemblyVersion=<true_or_false>
72+
```
7673

7774
**target** can be one of these values:
7875
*Clean*
@@ -90,6 +87,9 @@ Default value: *Release*
9087
**buildVersion** is the build version to set for the assembly or Nuget package.
9188
Default value: *1.0.0-build1*
9289

90+
**setAssemblyVersion** can be either *True* or *False*. When set to true the assembly version will be set to the value indicated by **buildVersion**.
91+
Default value: *False*
92+
9393
## Contributing
9494
1. Fork it!
9595
2. Create your feature branch: `git checkout -b my-new-feature`

0 commit comments

Comments
 (0)