Skip to content

Commit

Permalink
Add readme, sponsors, dogfooding sections
Browse files Browse the repository at this point in the history
  • Loading branch information
kzu committed Sep 21, 2021
1 parent 9a8b40c commit b920117
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 5 deletions.
3 changes: 2 additions & 1 deletion RxFree.sln
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RxFree", "src\RxFree\RxFree
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RxFree.Tests", "src\RxFree.Tests\RxFree.Tests.csproj", "{9C1BA247-9164-4A60-82F7-24364A353E1E}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "RxFree.SourceTests", "src\RxFree.SourceTests\RxFree.SourceTests.csproj", "{BA6410EE-DECB-435B-AD4F-DA8A78AA9D85}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RxFree.SourceTests", "src\RxFree.SourceTests\RxFree.SourceTests.csproj", "{BA6410EE-DECB-435B-AD4F-DA8A78AA9D85}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{768BF814-BBED-4362-A745-30F79160EA40}"
ProjectSection(SolutionItems) = preProject
.editorconfig = .editorconfig
readme.md = readme.md
EndProjectSection
EndProject
Global
Expand Down
40 changes: 36 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ An ultra-lightweight Rx source-only nuget to avoid depending on the full
[System.Reactive](https://www.nuget.org/packages/System.Reactive) for `IObservable<T>`
producers.

[![Version](https://img.shields.io/nuget/vpre/RxFree.svg?color=royalblue)](https://www.nuget.org/packages/RxFree)
[![Downloads](https://img.shields.io/nuget/dt/RxFree.svg?color=darkmagenta)](https://www.nuget.org/packages/RxFree)
[![License](https://img.shields.io/github/license/devlooped/RxFree.svg?color=blue)](https://github.com/devlooped/RxFree/blob/main/license.txt)
[![Build](https://github.com/devlooped/RxFree/workflows/build/badge.svg?branch=main)](https://github.com/devlooped/RxFree/actions)

# Usage

All of the documentation and samples for `Subject<T>` and the provided extension methods
(i.e. `Subscribe` overloads) that are officially available for `System.Reactive` apply to
this project as well, since the implementations are heavily based on it (taking them to
the bare essentials for source-only inclusion).

# Why

For the most part, a producer needs the `Subject<T>` (read more about
[using subjects](https://docs.microsoft.com/en-us/previous-versions/dotnet/reactive-extensions/hh242970(v=vs.103)))
and maybe the `ObservableExtensions` that provide `Subscribe` overloads to provide
Expand All @@ -25,7 +39,25 @@ classes for your own implementation usage, with no external dependencies. They a
visible in the project since NuGet provides them automatically to the compiler, embedded into
your own assembly, and which you can fully debug as any other code in your project.

[![Build Status](https://dev.azure.com/kzu/builds/_apis/build/status/RxFree?branchName=master)](https://build.azdo.io/kzu/oss/26)
[![Version](https://img.shields.io/nuget/vpre/RxFree.svg?color=royalblue)](https://www.nuget.org/packages/RxFree)
[![Downloads](https://img.shields.io/nuget/dt/RxFree.svg?color=darkmagenta)](https://www.nuget.org/packages/RxFree)
[![License](https://img.shields.io/github/license/kzu/RxFree.svg?color=darkorange)](LICENSE)

# Dogfooding

[![CI Version](https://img.shields.io/endpoint?url=https://shields.kzu.io/vpre/RxFree/main&label=nuget.ci&color=brightgreen)](https://pkg.kzu.io/index.json)
[![Build](https://github.com/devlooped/RxFree/workflows/build/badge.svg?branch=main)](https://github.com/devlooped/RxFree/actions)

We also produce CI packages from branches and pull requests so you can dogfood builds as quickly as they are produced.

The CI feed is `https://pkg.kzu.io/index.json`.

The versioning scheme for packages is:

- PR builds: *42.42.42-pr*`[NUMBER]`
- Branch builds: *42.42.42-*`[BRANCH]`.`[COMMITS]`



## Sponsors

[![sponsored](https://raw.githubusercontent.com/devlooped/oss/main/assets/images/sponsors.svg)](https://github.com/sponsors/devlooped) [![clarius](https://raw.githubusercontent.com/clarius/branding/main/logo/byclarius.svg)](https://github.com/clarius)[![clarius](https://raw.githubusercontent.com/clarius/branding/main/logo/logo.svg)](https://github.com/clarius)

*[get mentioned here too](https://github.com/sponsors/devlooped)!*
45 changes: 45 additions & 0 deletions src/RxFree/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
An ultra-lightweight Rx source-only nuget to avoid depending on the full
[System.Reactive](https://www.nuget.org/packages/System.Reactive) for `IObservable<T>`
producers.

[![Version](https://img.shields.io/nuget/vpre/RxFree.svg?color=royalblue)](https://www.nuget.org/packages/RxFree)
[![Downloads](https://img.shields.io/nuget/dt/RxFree.svg?color=darkmagenta)](https://www.nuget.org/packages/RxFree)
[![License](https://img.shields.io/github/license/devlooped/RxFree.svg?color=blue)](https://github.com/devlooped/RxFree/blob/main/license.txt)
[![Build](https://github.com/devlooped/RxFree/workflows/build/badge.svg?branch=main)](https://github.com/devlooped/RxFree/actions)

# Usage

All of the documentation and samples for `Subject<T>` and the provided extension methods
(i.e. `Subscribe` overloads) that are officially available for `System.Reactive` apply to
this project as well, since the implementations are heavily based on it (taking them to
the bare essentials for source-only inclusion).

# Why

For the most part, a producer needs the `Subject<T>` (read more about
[using subjects](https://docs.microsoft.com/en-us/previous-versions/dotnet/reactive-extensions/hh242970(v=vs.103)))
and maybe the `ObservableExtensions` that provide `Subscribe` overloads to provide
lambdas instead of an `IObserver<T>`.

In addition, typical activities of a producer are to handle disposables and potentially
filter/query/convert other producers they consume themselves. So the following simple
features are provided:

- `Disposable.Empty` and `Disposable.Create(Action)`
- `CompositeDisposable`: allows disposing subscriptions as a group
- `Subject<T>`: for producing observable sequences
- Extension methods for `IObservable<T>`:
* `Subscribe` overloads receiving delegates for onNext, onError and onCompleted
* `Select`/`Where`/`OfType` LINQ operators

This is what this project provides at the moment, in source form, in your project, as internal
classes for your own implementation usage, with no external dependencies. They are not even
visible in the project since NuGet provides them automatically to the compiler, embedded into
your own assembly, and which you can fully debug as any other code in your project.


## Sponsors

[![sponsored](https://raw.githubusercontent.com/devlooped/oss/main/assets/images/sponsors.svg)](https://github.com/sponsors/devlooped) [![clarius](https://raw.githubusercontent.com/clarius/branding/main/logo/byclarius.svg)](https://github.com/clarius)[![clarius](https://raw.githubusercontent.com/clarius/branding/main/logo/logo.svg)](https://github.com/clarius)

*[get mentioned here too](https://github.com/sponsors/devlooped)!*

0 comments on commit b920117

Please sign in to comment.