Skip to content
This repository was archived by the owner on Apr 4, 2023. It is now read-only.

Commit f9e18ed

Browse files
committed
edits
1 parent f75d629 commit f9e18ed

File tree

1 file changed

+27
-31
lines changed

1 file changed

+27
-31
lines changed

README.md

+27-31
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ For more information, see [Splunk Enterprise SDK for C#](https://dev.splunk.com/
1515

1616
Version 2.0 introduces new modern APIs that leverage the latest .NET platform advancements.
1717

18-
* Async: All APIs are 100% asynchronous supporting the new [async/await](http://msdn.microsoft.com/en-us/library/hh191443.aspx) features.
18+
* Async. All APIs are 100% asynchronous supporting the new [async/await](http://msdn.microsoft.com/en-us/library/hh191443.aspx) features.
1919
* All APIs follow .NET guidelines and abide by FxCop and StyleCop rules.
20-
* Reactive Extensions: Splunk Enterprise query results implement [IObservable<T>](http://msdn.microsoft.com/library/dd990377), allowing usage with the [.NET Reactive Extensions](http://msdn.microsoft.com/data/gg577610).
21-
* Support for cross-platform development: The Splunk API client (Splunk.Client.dll) in the new version is a [Portable Class Library](http://msdn.microsoft.com/library/vstudio/gg597391.aspx) supporting .NET development on multiple platforms.
20+
* Reactive Extensions. Splunk Enterprise query results implement [IObservable<T>](http://msdn.microsoft.com/library/dd990377), allowing usage with the [.NET Reactive Extensions](http://msdn.microsoft.com/data/gg577610).
21+
* Support for cross-platform development. The Splunk API client (Splunk.Client.dll) in the new version is a [Portable Class Library](http://msdn.microsoft.com/library/vstudio/gg597391.aspx) supporting .NET development on multiple platforms.
2222

2323
Below is an example of a simple one shot search:
2424

@@ -49,9 +49,9 @@ This SDK supports .NET 4.5/Mono 3.4, PCL (Windows 8.1, Windows Phone 8.1, iOS (v
4949

5050
The Splunk Enterprise SDK for C# version 2.x is a rewrite of the 1.x SDK, and introduces completely new APIs.
5151

52-
>**Important**: Applications built with Splunk Enterprise SDK for C# version 1.x will not recompile using Splunk Enterprise SDK for C# version 2.xf.__
52+
>**Important**: Applications built with Splunk Enterprise SDK for C# version 1.x will not recompile using Splunk Enterprise SDK for C# version 2.xf.
5353
54-
Splunk Enterprise SDK for C# version 2.x includes a subset of the capability in version 1.0 of the SDK, and focuses on the most common customer scenarios. The major focus areas are _search_, _search jobs_, _configuration_, and _modular inputs_.
54+
Splunk Enterprise SDK for C# version 2.x includes a subset of the capability in version 1.0 of the SDK, and focuses on the most common customer scenarios. The major focus areas are search, search jobs, configuration, and modular inputs.
5555

5656
The areas that are covered are:
5757
* Login
@@ -76,46 +76,42 @@ The Splunk Enterprise SDK for C# contains library code and examples that show ho
7676
Here's what you need to get going with the Splunk Enterprise SDK for C# version 2.x.
7777

7878
* Splunk Enterprise
79-
80-
If you haven't already installed Splunk Enterprise, download it [here](http://www.splunk.com/download). For more information, see the Splunk Enterprise [Installation Manual](https://docs.splunk.com/Documentation/Splunk/latest/Installation).
8179

82-
* The Splunk Enterprise SDK for C# has been tested with Splunk Enterprise 7.0 and 7.2.
80+
If you haven't already installed Splunk Enterprise, download it [here](http://www.splunk.com/download). For more information, see the Splunk Enterprise [Installation Manual](https://docs.splunk.com/Documentation/Splunk/latest/Installation).
8381

84-
#### Developer environments
82+
The Splunk Enterprise SDK for C# has been tested with Splunk Enterprise 7.0 and 7.2.
8583

86-
The Splunk Enterprise SDK for C# supports development in the following environments:
84+
* Splunk Enterprise SDK for C#
8785

88-
* Visual Studio
89-
The Splunk Enterprise SDK for C# supports development in [Microsoft Visual Studio](http://www.microsoft.com/visualstudio/downloads) 2012 and later
90-
91-
You must also install [Code Contracts for .NET](http://visualstudiogallery.msdn.microsoft.com/1ec7db13-3363-46c9-851f-1ce455f66970).
92-
>**Note**: Close Visual Studio first. Otherwise, the installation will not work, despite appearing to.
86+
* Use the MyGet feed
9387

94-
To run the unit tests, install an [xUnit](https://github.com/xunit/xunit) runner. If you use resharper, install its [xUnit.net Test Support](https://resharper-plugins.jetbrains.com/packages/xunitcontrib/1.6.2). Otherwise, install the [xUnit.net runner for Visual Studio 2012 and 2013](http://visualstudiogallery.msdn.microsoft.com/463c5987-f82b-46c8-a97e-b1cde42b9099).
88+
Download the Splunk SDK C# NuGet packages from [MyGet](http://www.myget.org). Add the following feed to your package sources in Visual Studio:
89+
`https://splunk.myget.org/F/splunk-sdk-csharp-pcl/`
9590

96-
* Xamarin Studio/Mono Develop
97-
The Splunk Enterprise SDK for C# support development in Xamarin Studio and Mono Develop. You will need to set the __MonoCS__ compilation constant in the project settings for Splunk.Client.csproj and Splunk.ModularInputs.csproj.
91+
The following packages are in that feed:
92+
* Splunk.Client: Client for Splunk's REST API. This is a portable library.
93+
* Splunk.ModularInputs: Functionality for building Modular Inputs.
9894

99-
To run the unit tests, download the latest release of [xUnit](https://github.com/xunit/xunit/releases) and run it using the command-line tools or GUI runner.
95+
>**Note**: Both packages are published to NuGet when the SDK is released.
10096
101-
### Splunk Enterprise SDK for C#
97+
* Get the source
10298

103-
#### MyGet feed
99+
Download the [Splunk Enterprise SDK for C# ZIP file](https://github.com/splunk/splunk-sdk-csharp-pcl/archive/master.zip) from GitHub and extract the contents. If you are want to contribute to the Splunk Enterprise SDK for C#, clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-csharp).
104100

105-
Download the Splunk SDK C# NuGet packages from [MyGet](http://www.myget.org). Add the following feed to your package sources in Visual Studio:
106-
https://splunk.myget.org/F/splunk-sdk-csharp-pcl/
101+
### Developer environments
107102

108-
The following packages are in that feed:
109-
* Splunk.Client: Client for Splunk's REST API. This is a portable library.
110-
* Splunk.ModularInputs: Functionality for building Modular Inputs.
103+
The Splunk Enterprise SDK for C# supports development in the following environments:
111104

112-
**Note**: Both packages are published to NuGet when the SDK is released.
105+
* Visual Studio
106+
The Splunk Enterprise SDK for C# supports development in [Microsoft Visual Studio](http://www.microsoft.com/visualstudio/downloads) 2012 and later
113107

114-
#### Get the source
108+
You must also install [Code Contracts for .NET](http://visualstudiogallery.msdn.microsoft.com/1ec7db13-3363-46c9-851f-1ce455f66970).
109+
>**Note**: Close Visual Studio first. Otherwise, the installation will not work, despite appearing to.
115110
116-
[Get the Splunk Enterprise SDK for C#](https://github.com/splunk/splunk-sdk-csharp-pcl/archive/master.zip). Download the ZIP file and extract its contents.
111+
To run the unit tests, install an [xUnit](https://github.com/xunit/xunit) runner. If you use resharper, install its [xUnit.net Test Support](https://resharper-plugins.jetbrains.com/packages/xunitcontrib/1.6.2). Otherwise, install the [xUnit.net runner for Visual Studio 2012 and 2013](http://visualstudiogallery.msdn.microsoft.com/463c5987-f82b-46c8-a97e-b1cde42b9099).
117112

118-
If you are want to contribute to the Splunk Enterprise SDK for C#, clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-csharp).
113+
* Xamarin Studio/Mono Develop
114+
The Splunk Enterprise SDK for C# support development in Xamarin Studio and Mono Develop. You will need to set the __MonoCS__ compilation constant in the project settings for Splunk.Client.csproj and Splunk.ModularInputs.csproj.
119115

120116
#### Build the SDK
121117

@@ -128,8 +124,8 @@ To build the SDK, the examples, and the unit tests after extracting or cloning t
128124

129125
The Splunk Enterprise SDK for C# includes full unit tests which run using [xunit](https://github.com/xunit/xunit) as well as several examples.
130126

131-
#### Solution layout
132127

128+
#### Solution layout
133129

134130
| Directory | Description |
135131
|:-------------- |:---------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)