Skip to content

Commit

Permalink
Update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
aritchie committed May 9, 2024
1 parent 442896a commit f5be7bc
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 25 deletions.
6 changes: 2 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Shiny v3 for .NET
# Shiny v4 for .NET
<img src="https://github.com/shinyorg/shiny/raw/master/art/logo.png" width="100" />

Shiny is a cross platform framework designed to make working with device services and background processes easy, testable, and consistent while bringing
things like dependency injection & logging in a structured way to your code!

## Supports
* Xamarin iOS
* Xamarin Android
* .NET 8 for Android
* .NET 8 for iOS
* .NET 8 for MacCatalyst
Expand All @@ -30,7 +28,7 @@ things like dependency injection & logging in a structured way to your code!
* [NuGets](https://www.nuget.org/profiles/ShinyLib)
* Samples
* [MAUI - Kitchen Sink](https://github.com/shinyorg/shiny/tree/master/samples/Sample.Maui)
* [Push](https://github.com/shinyorg/shiny/tree/master/samples/Sample.Push.Maui)
* [Push](https://github.com/shinyorg/pushtester)
* [BLE Client & Hosting](https://github.com/aritchie/digitalscoreboard)


Expand Down
27 changes: 6 additions & 21 deletions samples/readme.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,17 @@
# Shiny Samples

These samples make use great open source frameworks like [Prism](https://prismlibrary.com) & ReactiveUI (https://reactiveui.net) as well
as principles like dependency injection and reactive extensions... much like Shiny itself. If you find these complex or you simply don't like them, don't complain - the library wasn't built for you...
as principles like dependency injection and reactive extensions... much like Shiny itself.

If you find these complex OR you simply don't like them, don't complain - the library wasn't built for you...
remember - this is not a product!

[For the push sample, please GO HERE](https://github.com/shinyorg/pushtester)

## Sample (Sample.Maui)
A kitchen sink using all of the support libraries that don't require special external entitlements from Apple (like Push).
A kitchen sink using almost all of Shiny that don't require special external entitlements from Apple (like Push).
This sample also uses Shiny.Framework (https://github.com/shinyorg/framework) which has helpers around ReactiveUI & Prism.

## MAUI Push (Sample.Push.Maui)

* Open Sample.Push.Maui csproj
* Change <PushProvider> to native, firebase, or azure

* Platform Support

|Messaging Platform|iOS|Mac Catalyst|Android|
|------------------|---|------------|-------|
|Native|Yes|Yes|Yes|
|Azure|Yes|Yes|Yes|
|Firebase|Yes|No|Yes|

### Azure Notification Hubs
* Edit appsettings.json and add the appropriate values to the AzureNotificationHubs section

### Firebase Messaging
* Edit appsettings.apple.json & appsettings.android.json and enter the appropriate firebase values in each config file

## Blazor (Sample.Blazor)
Currently, a vast majority of the APIs that are coming to the web (ie. BluetoothLE, Notifications, & event GPS) are still experimental.
This is a testing platform not meant for general consumption. Don't expect much
Expand Down

0 comments on commit f5be7bc

Please sign in to comment.