Skip to content

Commit

Permalink
Update some README files
Browse files Browse the repository at this point in the history
  • Loading branch information
mburumaxwell committed Mar 7, 2024
1 parent 365b5b1 commit 7534eaa
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Dependabot](https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot)](https://dependabot.com/)
[![license](https://img.shields.io/github/license/tinglesoftware/dotnet-extensions.svg)](LICENSE)

This repository contains projects/libraries for adding useful functionality to dotnet and ASP.NET Core when running real-world applications in production. We have been using these packages at [Tingle](https://tingle.software) for years and thought it would be better if we shared them.
This repository contains projects/libraries for adding useful functionality to .NET and ASP.NET Core when running real-world applications in production. We have been using these packages at [Tingle](https://tingle.software) for years and thought it would be better if we shared them.

## Packages

Expand All @@ -19,13 +19,14 @@ This repository contains projects/libraries for adding useful functionality to d
|[`Tingle.Extensions.Caching.MongoDB`](https://www.nuget.org/packages/Tingle.Extensions.Caching.MongoDB/)|Distributed caching implemented with [MongoDB](https://mongodb.com) on top of `IDistributedCache`, inspired by [CosmosCache](https://github.com/Azure/Microsoft.Extensions.Caching.Cosmos). See [docs](./src/Tingle.Extensions.Caching.MongoDB/README.md) and [sample](./samples/AspNetCoreSessionState)|
|[`Tingle.Extensions.DataAnnotations`](https://www.nuget.org/packages/Tingle.Extensions.DataAnnotations/)|Additional data validation attributes in the `System.ComponentModel.DataAnnotations` namespace. Some of this should have been present in the framework but are very specific to some use cases. For example `FiveStarRatingAttribute`. See [docs](./src/Tingle.Extensions.DataAnnotations/README.md).|
|[`Tingle.Extensions.Http`](https://www.nuget.org/packages/Tingle.Extensions.Http/)|Lightweight abstraction around `HttpClient` which can be used to build custom client with response wrapping semantics. See [docs](./src/Tingle.Extensions.Http/README.md).|
|[`Tingle.Extensions.Http.Authentication`](https://www.nuget.org/packages/Tingle.Extensions.Http.Authentication/)|Authentication providers for use with HttpClient and includes support for DI via `Microsoft.Extensions.Http`. See [docs](./src/Tingle.Extensions.Http.Authentication/README.md) and [sample](./samples/HttpAuthenticationSample).|
|[`Tingle.Extensions.Http.Authentication`](https://www.nuget.org/packages/Tingle.Extensions.Http.Authentication/)|Authentication providers for use with `HttpClient` and includes support for DI via `Microsoft.Extensions.Http`. See [docs](./src/Tingle.Extensions.Http.Authentication/README.md) and [sample](./samples/HttpAuthenticationSample).|
|[`Tingle.Extensions.JsonPatch`](https://www.nuget.org/packages/Tingle.Extensions.JsonPatch/)|JSON Patch (RFC 6902) support for .NET to easily generate JSON Patch documents using `System.Text.Json` for client applications. See [docs](./src/Tingle.Extensions.JsonPatch/README.md).|
|[`Tingle.Extensions.MongoDB`](https://www.nuget.org/packages/Tingle.Extensions.MongoDB/)|Extensions for working with MongoDB. See [docs](./src/Tingle.Extensions.MongoDB/README.md) and [sample](./samples/MongoDBSample).|
|[`Tingle.Extensions.PhoneValidators`](https://www.nuget.org/packages/Tingle.Extensions.PhoneValidators/)|Convenience for validation of phone numbers either via attributes or resolvable services. See [docs](./src/Tingle.Extensions.PhoneValidators/README.md).|
|[`Tingle.Extensions.Primitives`](https://www.nuget.org/packages/Tingle.Extensions.Primitives/)|Extra primitive types such as `Money`, `Currency`, `Duration` etc. See [docs](./src/Tingle.Extensions.Primitives/README.md).|
|[`Tingle.Extensions.Processing`](https://www.nuget.org/packages/Tingle.Extensions.Processing/)|Helpers for making processing of bulk in memory tasks. See [docs](./src/Tingle.Extensions.Processing/README.md).|
|[`Tingle.Extensions.PushNotifications`](https://www.nuget.org/packages/Tingle.Extensions.PushNotifications/)|Clients for sending push notifications via FCM, APNS etc. See [docs](./src/Tingle.Extensions.PushNotifications/README.md).|
|[`Tingle.Extensions.Serilog`](https://www.nuget.org/packages/Tingle.Extensions.Serilog/)|Extensions for working with [Serilog](https://serilog.net/). Including easier registration when working with different host setups, and general basics. See [docs](./src/Tingle.Extensions.Serilog/README.md) and [sample](./samples/SerilogSample).|
|[`Tingle.Extensions.PushNotifications`](https://www.nuget.org/packages/Tingle.Extensions.PushNotifications/)|Clients for sending push notifications via FCM, APNs etc. See [docs](./src/Tingle.Extensions.PushNotifications/README.md).|
|[`Tingle.Extensions.Serilog`](https://www.nuget.org/packages/Tingle.Extensions.Serilog/)|Extensions for working with [`Serilog`](https://serilog.net/). Including easier registration when working with different host setups, and general basics. See [docs](./src/Tingle.Extensions.Serilog/README.md) and [sample](./samples/SerilogSample).|

### Issues & Comments

Expand Down
9 changes: 6 additions & 3 deletions src/Tingle.Extensions.MongoDB/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Tingle.Extensions.MongoDB

> [!NOTE] The use of `MongoDbContext` will likely be replaced by EfCore support for Mongo [here](https://github.com/mongodb/mongo-efcore-provider).
> [!CAUTION]
> The use of `MongoDbContext` will likely be replaced by EntityFrameworkCore support for MongoDB [here](https://github.com/mongodb/mongo-efcore-provider).
`MongoDB` is a cross-platform NoSQL database program which uses JSON like documents with schema.

Expand Down Expand Up @@ -60,5 +61,7 @@ services.AddHealthChecks()
## Extensions

A number of extensions for building indexes or performing operations on collections exist.
See extensions for building ascending/descending indexes [here](https://github.com/tinglesoftware/dotnet-extensions/blob/main/src/Tingle.Extensions.MongoDB/Extensions/BuildersExtensions.cs)
See extensions for bulk operations [here](https://github.com/tinglesoftware/dotnet-extensions/blob/main/src/Tingle.Extensions.MongoDB/Extensions/IMongoCollectionExtensions.cs)

See extensions for building ascending/descending indexes [here](https://github.com/tinglesoftware/dotnet-extensions/blob/365b5b13cbb242d039a4ac61a5b9fb341580b04a/src/Tingle.Extensions.MongoDB/Extensions/BuildersExtensions.cs)

See extensions for bulk operations [here](https://github.com/tinglesoftware/dotnet-extensions/blob/365b5b13cbb242d039a4ac61a5b9fb341580b04a/src/Tingle.Extensions.MongoDB/Extensions/IMongoCollectionExtensions.cs)
8 changes: 4 additions & 4 deletions src/Tingle.Extensions.Primitives/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,10 @@ Represents a SWIFT Code broken down into its components. The format of a Swift C

```cs
var sw = SwiftCode.Parse("KCBLKENXXXX");
Console.WriteLine(sw.Institution); // KCBL
Console.WriteLine(sw.Country); // KE
Console.WriteLine(sw.Location); // NX
Console.WriteLine(sw.Branch); // XXX
Console.WriteLine(sw.Institution); // "KCBL"
Console.WriteLine(sw.Country); // "KE"
Console.WriteLine(sw.Location); // "NX"
Console.WriteLine(sw.Branch); // "XXX"
```

## `Keygen`
Expand Down

0 comments on commit 7534eaa

Please sign in to comment.