瀏覽代碼

Merge pull request #215 from LeeCampbell/patch-1

Update Readme with Nuget naming changes
Oren Novotny 9 年之前
父節點
當前提交
b76b75b285
共有 1 個文件被更改,包括 24 次插入11 次删除
  1. 24 11
      README.md

+ 24 - 11
README.md

@@ -1,22 +1,35 @@
 Reactive Extensions
 ======================
 
-Channel  | Rx | Ix | 
+Channel  | Rx | Ix |
 -------- | :------------: | :-------------: |
-AppVeyor<br>([home](https://ci.appveyor.com/project/dotnetfoundation/rx-net)) | ![#](https://img.shields.io/appveyor/ci/dotnetfoundation/rx-net/master.svg) | ![#](https://img.shields.io/appveyor/ci/dotnetfoundation/rx-net/master.svg) 
-NuGet.org | ![#](https://img.shields.io/nuget/v/Rx-Main.svg) | ![#](https://img.shields.io/nuget/v/Ix-Main.svg) 
+AppVeyor<br>([home](https://ci.appveyor.com/project/dotnetfoundation/rx-net)) | ![#](https://img.shields.io/appveyor/ci/dotnetfoundation/rx-net/master.svg) | ![#](https://img.shields.io/appveyor/ci/dotnetfoundation/rx-net/master.svg)
+NuGet.org | ![#](https://img.shields.io/nuget/v/System.Reactive.svg) | ![#](https://img.shields.io/nuget/v/System.Interactive.svg)
 MyGet<br>([gallery](https://dotnet.myget.org/gallery/rx)) | ![#](https://img.shields.io/dotnet.myget/rx/vpre/System.Reactive.svg)<br>![#](https://img.shields.io/dotnet.myget/rx/v/System.Reactive.svg) | ![#](https://img.shields.io/dotnet.myget/rx/vpre/System.Interactive.svg)<br>![#](https://img.shields.io/dotnet.myget/rx/v/System.Interactive.svg)  
 
 ### Join the conversation
 
 Catch us in the #rx and #ix channels over in the [.NET Slack](http://tattoocoder.com/aspnet-slack-sign-up/).
-[![.NET Slack Status](https://aspnetcoreslack.herokuapp.com/badge.svg?2)](http://tattoocoder.com/aspnet-slack-sign-up/) 
+[![.NET Slack Status](https://aspnetcoreslack.herokuapp.com/badge.svg?2)](http://tattoocoder.com/aspnet-slack-sign-up/)
 
 ### Get nightly builds
 - NuGet v3 feed url (VS 2015+): `https://dotnet.myget.org/F/rx/api/v3/index.json`
 - NuGet v2 feed url (VS 2012+): `https://dotnet.myget.org/F/rx/`
 - Symbol server url: `https://dotnet.myget.org/F/rx/symbols/`
 
+### Breaking changes
+The NuGet packages have changed their package naming in the move from v2.x.x to v3.0.0
+ * ~~`Rx-Main`~~ is now `System.Reactive`
+ * ~~`Rx-Core`~~ is now `System.Reactive.Core`
+ * ~~`Rx-Interfaces`~~  is now `System.Reactive.Interfaces`
+ * ~~`Rx-Linq`~~  is now `System.Reactive.Linq`
+ * ~~`Rx-PlatformServices`~~  is now `System.Reactive.PlatformServices`
+ * ~~`Rx-Testing`~~  is now `Microsoft.Reactive.Testing`
+
+This brings the NuGet package naming in line with NuGet guidelines and also the dominant namespace in each package.
+The strong name key has also changed, which is considered a breaking change.
+However, there are no expected API changes, therefore, once you make the NuGet change, no code changes should be necessary.
+
 A Brief Intro
 -------------------
 
@@ -29,7 +42,7 @@ Using Rx, you can represent multiple asynchronous data streams (that come from d
 Because observable sequences are data streams, you can query them using standard LINQ query operators implemented by the Observable extension methods. Thus you can filter, project, aggregate, compose and perform time-based operations on multiple events easily by using these standard LINQ operators. In addition, there are a number of other reactive stream specific operators that allow powerful queries to be written.  Cancellation, exceptions, and synchronization are also handled gracefully by using the extension methods provided by Rx.
 
 Rx complements and interoperates smoothly with both synchronous data streams (`IEnumerable<T>`) and single-value asynchronous computations (`Task<T>`) as the following diagram shows:
-  	
+
 
 <table>
    <th></th><th>Single return value</th><th>Multiple return values</th>
@@ -52,11 +65,11 @@ Flavors of Rx
 
 * __Rx.NET__: *(this repository)* The Reactive Extensions (Rx) is a library for composing asynchronous and event-based programs using observable sequences and LINQ-style query operators.
 * [RxJS 4](https://github.com/Reactive-Extensions/RxJS) / [RxJS 5 beta](https://github.com/ReactiveX/rxjs): The Reactive Extensions for JavaScript (RxJS) is a library for composing asynchronous and event-based programs using observable sequences and LINQ-style query operators in JavaScript which can target both the browser and Node.js.
-* [RxJava](https://github.com/ReactiveX/RxJava): Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM. 
-* [RxScala](https://github.com/ReactiveX/RxScala): Reactive Extensions for Scala – a library for composing asynchronous and event-based programs using observable sequences 
+* [RxJava](https://github.com/ReactiveX/RxJava): Reactive Extensions for the JVM – a library for composing asynchronous and event-based programs using observable sequences for the Java VM.
+* [RxScala](https://github.com/ReactiveX/RxScala): Reactive Extensions for Scala – a library for composing asynchronous and event-based programs using observable sequences
 * [RxCpp](https://github.com/Reactive-Extensions/RxCpp): The Reactive Extensions for Native (RxCpp) is a library for composing asynchronous and event-based programs using observable sequences and LINQ-style query operators in both C and C++.
 * [Rx.rb](http://rxrb.codeplex.com): A prototype implementation of Reactive Extensions for Ruby (Rx.rb).
-* [RxPy](https://github.com/Reactive-Extensions/RxPy): The Reactive Extensions for Python 3 (Rx.Py) is a set of libraries to compose asynchronous and event-based programs using observable collections and LINQ-style query operators in Python 3. 
+* [RxPy](https://github.com/Reactive-Extensions/RxPy): The Reactive Extensions for Python 3 (Rx.Py) is a set of libraries to compose asynchronous and event-based programs using observable collections and LINQ-style query operators in Python 3.
 
 
 Interactive Extensions
@@ -70,7 +83,7 @@ Applications
 * [Tx](https://github.com/Reactive-Extensions/Tx): a set of code samples showing how to use LINQ to events, such as real-time standing queries and queries on past history from trace and log files, which targets ETW, Windows Event Logs and SQL Server Extended Events.
 * [LINQ2Charts](http://linq2charts.codeplex.com): an example for Rx bindings.  Similar to existing APIs like LINQ to XML, it allows developers to use LINQ to create/change/update charts in an easy way and avoid having to deal with XML or other underneath data structures. We would love to see more Rx bindings like this one.
 
-Contributing 
+Contributing
 ------------------
 
 ### Source code
@@ -80,7 +93,7 @@ Contributing
 
 ### Contribute!
 
-Some of the best ways to contribute are to try things out, file bugs, and join in design conversations. 
+Some of the best ways to contribute are to try things out, file bugs, and join in design conversations.
 
 * [How to Contribute](https://github.com/Reactive-Extensions/Rx.NET/wiki/Contributing-Code)
 * [Pull requests](https://github.com/Reactive-Extensions/Rx.NET/pulls): [Open](https://github.com/Reactive-Extensions/Rx.NET/pulls?q=is%3Aopen+is%3Apr)/[Closed](https://github.com/Reactive-Extensions/Rx.NET/pulls?q=is%3Apr+is%3Aclosed)
@@ -92,4 +105,4 @@ This project has adopted a code of conduct adapted from the [Contributor Covenan
 ### .NET Foundation
 
 This project is part of the [.NET Foundation](http://www.dotnetfoundation.org/projects) along with other
-projects like [the class libraries for .NET Core](https://github.com/dotnet/corefx/). 
+projects like [the class libraries for .NET Core](https://github.com/dotnet/corefx/).