Skip to content

Commit be54073

Browse files
jamesmcroftjamesmcroft
committed
Updated README and added project specific README files
1 parent 7834966 commit be54073

File tree

30 files changed

+723
-137
lines changed

30 files changed

+723
-137
lines changed

‎README.md‎

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,46 @@
22

33
# MADE.NET
44

5-
MADE.NET is a toolkit of easy-to-use extensions, helpers, and controls to make app development easier for .NET developers.
5+
[![GitHub release](https://img.shields.io/github/release/MADE-Apps/MADE.NET.svg)](https://github.com/MADE-Apps/MADE.NET/releases)
6+
[![Build status](https://github.com/MADE-Apps/MADE.NET/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MADE-Apps/MADE.NET/actions/workflows/ci.yml)
7+
[![Twitter Followers](https://img.shields.io/twitter/follow/jamesmcroft?label=follow%20%40jamesmcroft&style=flat)](https://twitter.com/jamesmcroft)
8+
[![Nuget](https://img.shields.io/nuget/v/MADE.Collections.svg)](https://www.nuget.org/profiles/made-apps)
9+
[![MADE.NET docs](https://img.shields.io/badge/docs-MADE.NET-blue.svg)](https://made-apps.github.io/MADE.NET/)
610

7-
Whether you're building an ASP.NET Core Web API or a native UI application with Uno Platform, MADE.NET has something for everyone.
11+
MADE.NET is a suite of libraries built on the boilerplate, reusable components, services, extensions, and helpers that we all drop into our projects. With MADE.NET, you can get all of these in one place, easy to use and consume, to make app development easier for you.
812

9-
MADE.NET has been built on common code from projects built by the MADE team, and is now a home for all those bits of code that you know you will reuse in another project!
13+
Whether you're building an ASP.NET Core API or a native app experience with MAUI, MADE.NET has something for everyone.
1014

11-
## Support MADE.NET ♥
12-
13-
As many developers know, projects like MADE.NET are built and maintained in spare time. If you find this project useful, please **Star** the repo and if possible, sponsor the project development on GitHub.
15+
**[Discover what's new in MADE.NET](https://github.com/MADE-Apps/MADE.NET/releases)**
1416

15-
## Build Status
17+
## Getting started ⭐
1618

17-
| Build | Status | Current Version |
18-
| ------ | ------ | ------ |
19-
| Packages | [![CI](https://github.com/MADE-Apps/MADE.NET/actions/workflows/ci.yml/badge.svg)](https://github.com/MADE-Apps/MADE.NET/actions/workflows/ci.yml) | [![NuGet](https://img.shields.io/nuget/v/MADE.Runtime)](https://www.nuget.org/profiles/made-apps) |
20-
| Docs | [![Docs](https://github.com/MADE-Apps/MADE.NET/actions/workflows/docs.yml/badge.svg)](https://github.com/MADE-Apps/MADE.NET/actions/workflows/docs.yml) | N/A |
19+
To start building your own applications with the MADE.NET libraries, you can install any of the libraries into your dotnet application.
2120

22-
## Installation 💾
21+
```bash
22+
dotnet add package MADE.{Package}
23+
```
2324

24-
[MADE.NET](https://www.nuget.org/profiles/made-apps) components are publicly available via NuGet. Each available package is detailed below.
25+
Or by adding any of the MADE.NET packages in your NuGet package manager of choice.
2526

26-
| Package | Current | Preview | Downloads |
27-
| ------ | ------ | ------ | ------ |
28-
| Collections | [![NuGet](https://img.shields.io/nuget/v/MADE.Collections)](https://www.nuget.org/packages/MADE.Collections/) | [![Nuget](https://img.shields.io/nuget/vpre/MADE.Collections.svg)](https://www.nuget.org/packages/MADE.Collections/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Collections.svg)](https://www.nuget.org/packages/MADE.Collections) |
29-
| Data.Converters | [![NuGet](https://img.shields.io/nuget/v/MADE.Data.Converters)](https://www.nuget.org/packages/MADE.Data.Converters/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Data.Converters)](https://www.nuget.org/packages/MADE.Data.Converters/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.Converters.svg)](https://www.nuget.org/packages/MADE.Data.Converters) |
30-
| Data.EFCore | [![NuGet](https://img.shields.io/nuget/v/MADE.Data.EFCore)](https://www.nuget.org/packages/MADE.Data.EFCore/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Data.EFCore)](https://www.nuget.org/packages/MADE.Data.EFCore/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.EFCore.svg)](https://www.nuget.org/packages/MADE.Data.EFCore) |
31-
| Data.Serialization | [![NuGet](https://img.shields.io/nuget/v/MADE.Data.Serialization)](https://www.nuget.org/packages/MADE.Data.Serialization/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Data.Serialization)](https://www.nuget.org/packages/MADE.Data.Serialization/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.Serialization.svg)](https://www.nuget.org/packages/MADE.Data.Serialization) |
32-
| Data.Validation | [![NuGet](https://img.shields.io/nuget/v/MADE.Data.Validation)](https://www.nuget.org/packages/MADE.Data.Validation/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Data.Validation)](https://www.nuget.org/packages/MADE.Data.Validation/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.Validation.svg)](https://www.nuget.org/packages/MADE.Data.Validation) |
33-
| Data.Validation.FluentValidation | [![NuGet](https://img.shields.io/nuget/v/MADE.Data.Validation.FluentValidation)](https://www.nuget.org/packages/MADE.Data.Validation.FluentValidation/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Data.Validation.FluentValidation)](https://www.nuget.org/packages/MADE.Data.Validation.FluentValidation/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.Validation.FluentValidation.svg)](https://www.nuget.org/packages/MADE.Data.Validation.FluentValidation) |
34-
| Diagnostics | [![NuGet](https://img.shields.io/nuget/v/MADE.Diagnostics)](https://www.nuget.org/packages/MADE.Diagnostics/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Diagnostics)](https://www.nuget.org/packages/MADE.Diagnostics/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Diagnostics.svg)](https://www.nuget.org/packages/MADE.Diagnostics) |
35-
| Foundation | [![NuGet](https://img.shields.io/nuget/v/MADE.Foundation)](https://www.nuget.org/packages/MADE.Foundation/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Foundation)](https://www.nuget.org/packages/MADE.Foundation/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Foundation.svg)](https://www.nuget.org/packages/MADE.Foundation) |
36-
| Networking | [![NuGet](https://img.shields.io/nuget/v/MADE.Networking)](https://www.nuget.org/packages/MADE.Networking/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Networking)](https://www.nuget.org/packages/MADE.Networking/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Networking.svg)](https://www.nuget.org/packages/MADE.Networking) |
37-
| Runtime | [![NuGet](https://img.shields.io/nuget/v/MADE.Runtime)](https://www.nuget.org/packages/MADE.Runtime/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Runtime)](https://www.nuget.org/packages/MADE.Runtime/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Runtime.svg)](https://www.nuget.org/packages/MADE.Runtime) |
38-
| Testing | [![NuGet](https://img.shields.io/nuget/v/MADE.Testing)](https://www.nuget.org/packages/MADE.Testing/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Testing)](https://www.nuget.org/packages/MADE.Testing/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Testing.svg)](https://www.nuget.org/packages/MADE.Testing) |
39-
| Threading | [![NuGet](https://img.shields.io/nuget/v/MADE.Threading)](https://www.nuget.org/packages/MADE.Threading/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Threading)](https://www.nuget.org/packages/MADE.Threading/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Threading.svg)](https://www.nuget.org/packages/MADE.Threading) |
40-
| Web | [![NuGet](https://img.shields.io/nuget/v/MADE.Web)](https://www.nuget.org/packages/MADE.Web/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Web)](https://www.nuget.org/packages/MADE.Web/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Web.svg)](https://www.nuget.org/packages/MADE.Web) |
41-
| Web.Mvc | [![NuGet](https://img.shields.io/nuget/v/MADE.Web.Mvc)](https://www.nuget.org/packages/MADE.Web.Mvc/) | [![NuGet](https://img.shields.io/nuget/vpre/MADE.Web.Mvc)](https://www.nuget.org/packages/MADE.Web.Mvc/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Web.Mvc.svg)](https://www.nuget.org/packages/MADE.Web.Mvc) |
27+
Here's a complete list of available packages:
4228

43-
## Contributing 🚀
44-
45-
Looking to help build MADE.NET? Take a look through our [contribution guidelines](CONTRIBUTING.md). We actively encourage you to jump in and help with any issues!
29+
| Package | Download |
30+
| --- | --- |
31+
| Collections | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Collections.svg)](https://www.nuget.org/packages/MADE.Collections) |
32+
| Data.Converters | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.Converters.svg)](https://www.nuget.org/packages/MADE.Data.Converters) |
33+
| Data.EFCore | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.EFCore.svg)](https://www.nuget.org/packages/MADE.Data.EFCore) |
34+
| Data.Serialization | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.Serialization.svg)](https://www.nuget.org/packages/MADE.Data.Serialization) |
35+
| Data.Validation | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.Validation.svg)](https://www.nuget.org/packages/MADE.Data.Validation) |
36+
| Data.Validation.FluentValidation | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Data.Validation.FluentValidation.svg)](https://www.nuget.org/packages/MADE.Data.Validation.FluentValidation) |
37+
| Diagnostics | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Diagnostics.svg)](https://www.nuget.org/packages/MADE.Diagnostics) |
38+
| Foundation | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Foundation.svg)](https://www.nuget.org/packages/MADE.Foundation) |
39+
| Networking | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Networking.svg)](https://www.nuget.org/packages/MADE.Networking) |
40+
| Runtime | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Runtime.svg)](https://www.nuget.org/packages/MADE.Runtime) |
41+
| Testing | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Testing.svg)](https://www.nuget.org/packages/MADE.Testing) |
42+
| Threading | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Threading.svg)](https://www.nuget.org/packages/MADE.Threading) |
43+
| Web | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Web.svg)](https://www.nuget.org/packages/MADE.Web) |
44+
| Web.Mvc | [![NuGet Downloads](https://img.shields.io/nuget/dt/MADE.Web.Mvc.svg)](https://www.nuget.org/packages/MADE.Web.Mvc) |
4645

4746
## Building MADE.NET 🛠
4847

@@ -55,6 +54,18 @@ You can build the solution using Visual Studio with the following workloads inst
5554
- Mobile Development with .NET
5655
- .NET Core cross-platform development
5756

57+
## Contributing 🤝
58+
59+
Contributions, issues, and feature requests are welcome to MADE.NET!
60+
61+
Feel free to check the [issues page](https://github.com/MADE-Apps/MADE.NET/issues). You can also take a look at the [contributing guide](CONTRIBUTING.md).
62+
63+
We actively encourage you to jump in and help with any issues, and if you find one, don't forget to log it!
64+
65+
## Support MADE.NET ♥
66+
67+
As many developers know, projects like MADE.NET are built and maintained in spare time. If you find this project useful, please **Star** the repo and if possible, sponsor the project development on GitHub.
68+
5869
## License
5970

6071
MADE.NET is made available under the terms and conditions of the [MIT license](LICENSE).

‎src/Directory.Build.props‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
<Project>
22

33
<PropertyGroup>
4+
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
5+
<OutputType>Library</OutputType>
6+
<ImplicitUsings>enable</ImplicitUsings>
47
<PublishRepositoryUrl>true</PublishRepositoryUrl>
58
<EmbedUntrackedSources>true</EmbedUntrackedSources>
69
<IncludeSymbols>true</IncludeSymbols>
@@ -13,6 +16,7 @@
1316
<PackageProjectUrl>https://github.com/MADE-Apps/MADE.NET</PackageProjectUrl>
1417
<PackageLicenseFile>LICENSE</PackageLicenseFile>
1518
<PackageIcon>ProjectIcon.jpg</PackageIcon>
19+
<PackageReadmeFile>README.md</PackageReadmeFile>
1620
<PackageReleaseNotes>https://github.com/MADE-Apps/MADE.NET/releases</PackageReleaseNotes>
1721
<NeutralLanguage>en</NeutralLanguage>
1822
<GenerateDocumentationFile>true</GenerateDocumentationFile>
@@ -22,6 +26,7 @@
2226
<ItemGroup>
2327
<None Include="..\..\assets\ProjectIcon.jpg" Pack="true" PackagePath=""/>
2428
<None Include="..\..\LICENSE" Pack="true" PackagePath=""/>
29+
<None Include="README.md" Pack="true" PackagePath=""/>
2530
</ItemGroup>
2631

2732
<ItemGroup>

‎src/MADE.Collections/MADE.Collections.csproj‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,11 @@
22

33
<PropertyGroup>
44
<TargetFramework>netstandard2.0</TargetFramework>
5-
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
65
<Product>MADE.NET Collections</Product>
76
<Description>
8-
This package includes:
9-
- CollectionExtensions for extending collection objects with helper methods, such as updating an item or making two collections equal.
10-
- DictionaryExtensions for extending dictionary objects with helper methods, such as adding or updating an item based on a key.
11-
- GenericEqualityComparer for providing a simple IEqualityComparer for objects.
12-
- ObservableItemCollection for providing an ObservableCollection that manages both collection changed and item property changed events.
13-
- QueryableExtensions for extending queryable objects with helper methods, such as chunking the query into batched sizes.
7+
MADE.NET Collections allows you to easily interact with collections, lists, arrays, and dictionaries.
148
</Description>
15-
<PackageTags>MADE Collections Observable Equality Extensions Dictionary Chunk</PackageTags>
9+
<PackageTags>MADE Collection List Array Dictionary Queryable Observable Equality Extensions Chunk</PackageTags>
1610
</PropertyGroup>
1711

1812
</Project>

‎src/MADE.Collections/README.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# MADE.NET Collections
2+
3+
[![GitHub release](https://img.shields.io/github/release/MADE-Apps/MADE.NET.svg)](https://github.com/MADE-Apps/MADE.NET/releases)
4+
[![Build status](https://github.com/MADE-Apps/MADE.NET/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MADE-Apps/MADE.NET/actions/workflows/ci.yml)
5+
[![Twitter Followers](https://img.shields.io/twitter/follow/jamesmcroft?label=follow%20%40jamesmcroft&style=flat)](https://twitter.com/jamesmcroft)
6+
[![Nuget](https://img.shields.io/nuget/v/MADE.Collections.svg)](https://www.nuget.org/packages/MADE.Collections)
7+
[![MADE.NET docs](https://img.shields.io/badge/docs-MADE.NET-blue.svg)](https://made-apps.github.io/MADE.NET/)
8+
9+
The MADE.NET Collections library allows you to easily interact with collections, lists, arrays, and dictionaries with out-of-the-box extensions. It also comes with implementations for new collection types and comparison helpers.
10+
11+
## Features ⭐
12+
13+
- **GenericEqualityComparer** - For providing an equality comparer wrapper for any type.
14+
- **ObservableItemCollection** - An ObservableCollection that manages both collection change events as well as contained item property change events.
15+
- **CollectionExtensions** - Extending collection objects with methods for easily updating an existing object in the collection, or updating a collection to equal each other. [Discover the extensions available for collections in our documentation](https://made-apps.github.io/MADE.NET/api/MADE.Collections.CollectionExtensions.html).
16+
- **DictionaryExtensions** - Providing helper methods for adding or updating items in a dictionary based on a given key, or getting a value or default for a given key. [Find out more about extensions for dictionaries](https://made-apps.github.io/MADE.NET/api/MADE.Collections.DictionaryExtensions.html).
17+
- **QueryableExtensions** - A collection of extensions for queryable objects that allow chunking queries into batched sizes. [Explore more helpers for queryable objects](https://made-apps.github.io/MADE.NET/api/MADE.Collections.QueryableExtensions.html).
18+
19+
## Getting started
20+
21+
### Get the library
22+
23+
You can install the Collections library into your dotnet application by running the following command:
24+
25+
```bash
26+
dotnet add package MADE.Collections
27+
```
28+
29+
Or by adding the `MADE.Collections` package in your NuGet package manager of choice.
30+
31+
## Contributing 🤝🏻
32+
33+
Contributions, issues and feature requests are welcome!
34+
35+
Feel free to check the [issues page](https://github.com/MADE-Apps/MADE.NET/issues). You can also take a look at the [contributing guide](https://github.com/MADE-Apps/MADE.NET/blob/main/CONTRIBUTING.md).
36+
37+
We actively encourage you to jump in and help with any issues, and if you find one, don't forget to log it!
38+
39+
## Support this project 💗
40+
41+
As many developers know, projects like this are built and maintained in maintainers' spare time. If you find this project useful, [please **Star** or sponsor the repo on GitHub](https://github.com/MADE-Apps/MADE.NET).
42+
43+
## License
44+
45+
This project is made available under the terms and conditions of the [MIT license](LICENSE).

‎src/MADE.Data.Converters/MADE.Data.Converters.csproj‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,12 @@
22

33
<PropertyGroup>
44
<TargetFrameworks>netstandard2.0;uap10.0.17763</TargetFrameworks>
5-
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
65
<Product>MADE.NET Data Converters</Product>
76
<Description>
8-
This package includes:
9-
- BooleanToStringValueConverter for converting between a boolean and a given string value.
10-
- DateTimeExtensions for extending DateTime objects with helper methods, such as getting current age or setting time.
11-
- DateTimeToStringValueConverter for converting between a DateTime and string value.
12-
- MathExtensions for providing additional mathematical functions such as Degrees to Radians.
13-
- StringExtensions for converting a string to other value types such as int, float, double, or boolean.
7+
MADE.NET Data Converters provide out-of-the-box value converters for taking values of one type and changing them to another.
8+
The advantage of the IValueConverter is that they can be chained together. The library also contains extension helpers for converting values directly.
149
</Description>
15-
<PackageTags>MADE Data Value Converter DateTime Math</PackageTags>
10+
<PackageTags>MADE Data Converter ValueConverter Boolean Collection DateTime String Extensions</PackageTags>
1611
</PropertyGroup>
1712

1813
<ItemGroup>

0 commit comments

Comments
 (0)