Skip to content

Add short description of all projects to start of readme #1881

Closed
@idg10

Description

@idg10

The discussion at #1868 (comment) has revealed that the repo-level readme file does not do a great job of guiding people who arrived at the repo (perhaps via the link on NuGet) without knowing very much about Rx. It's not obvious what's in here, and why there are several apparently different features in different libraries all in one repository.

We need a succinct description of the things that are in this repository. It contains:

  • Rx.NET (aka System.Reactive)
  • LINQ for IAsyncEnumerable (aka System.Linq.Async)
  • Ix.NET (aka System.Interactive)

These are somewhat different things (although they're conceptually united under "LINQ to everything" and more specifically "LINQ over sequences of things" which is why all three are in the same repo). So we should add a brief "What's in here, what's it for, and where do I look next to find out more?" section, answering those questions for each of the three things above.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions