Skip to content

Commit 3f98228

Browse files
update README + rm unnecessary dependencies
1 parent 817fae2 commit 3f98228

3 files changed

Lines changed: 26 additions & 20 deletions

File tree

Directory.Build.props

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
<Project>
33
<PropertyGroup>
44
<Version>0.0.9</Version>
5+
<VersionSuffix Condition="'$(Configuration)' == 'Debug'">-beta</VersionSuffix>
56
<AssemblyName>$(ProjectName)</AssemblyName>
67
<Company>The Aridity Team</Company>
78
<LangVersion>latest</LangVersion>

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# AridityTeam.Ascorbic
22

3-
The main core platform library for The Aridity Team projects.
3+
The main platform core library for The Aridity Team projects.
44

55
This library contains the core functionalities and abstractions that are shared across various projects within The Aridity Team ecosystem.
66
It serves as the foundation for building applications and services that adhere to the team's standards and practices.
77

8+
We've made this library available for anyone to use in their projects, in hopes that it will be useful, and make things simple for them in the future.
9+
10+
Contributions are always welcome, and it helps improve our other projects as well! To start contributing, you can read
11+
[CONTRIBUTING.md](https://github.com/aridityteam/ascorbic/blob/master/CONTRIBUTING.md) to help you getting started on your first contribution into project.
12+
813
## Features
914

1015
- **Observable Collections**: A collection that provides notifications when items get added, removed, or when the whole list is refreshed.
@@ -21,12 +26,23 @@ It serves as the foundation for building applications and services that adhere t
2126
- **Logging**: A logging framework that supports various log levels and output formats, making it easier to track application behavior.
2227
- **Extensions**: AridityTeam.Ascorbic provides variety of extension methods for base .NET types. (`string`, `TextWriter`, and `Stream`).
2328
- **Service Management**: A utility that manages registered services, to be used in singleton instances.
24-
- **Polyfills**: AridityTeam.Ascorbic provides extension methods to be able to use (some of) the latest .NET APIs in older framework runtimes.
29+
- **Polyfills**: AridityTeam.Ascorbic provides extension methods to be able to use (some of) the latest .NET APIs in older framework runtimes, like .NET Framework v4.7.2.
2530

2631
## License
2732

28-
This library, and some of other third-party components used is licensed under the MIT/X11 License. License terms may apply here.
33+
This library, and most of the other third-party components used is licensed under the MIT/X11 License. License terms may apply here.
2934

3035
### Third-party software used
3136

32-
- [Microsoft.VisualStudio.Validation](https://github.com/microsoft/vs-validation) (MIT License)
37+
Here is a list of third-party software used inside Ascorbic's code, in which made this library, and our other projects possible:
38+
39+
- [Nullable](https://www.nuget.org/packages/Nullable) (MIT License)
40+
- [PolyType](https://www.nuget.org/packages/PolyType) (MIT License)
41+
- [System.Composition](https://www.nuget.org/packages/System.Composition) (MIT License)
42+
- [System.ComponentModel.Composition](https://www.nuget.org/packages/System.ComponentModel.Composition) (MIT License)
43+
- [System.Text.Json](https://www.nuget.org/packages/System.Text.Json) (MIT License)
44+
- [System.Net.Http](https://www.nuget.org/packages/System.Net.Http) (MIT License)
45+
- [Microsoft.Bcl.AsyncInterfaces](https://www.nuget.org/packages/Microsoft.Bcl.AsyncInterfaces) (MIT License)
46+
- [Microsoft.Bcl.Memory](https://www.nuget.org/packages/Microsoft.Bcl.Memory) (MIT License)
47+
- [Microsoft.Bcl.HashCode](https://www.nuget.org/packages/Microsoft.Bcl.HashCode) (MIT License)
48+
- [Microsoft.VisualStudio.Validation](https://www.nuget.org/packages/Microsoft.VisualStudio.Validation) (MIT License)

src/AridityTeam.Ascorbic/AridityTeam.Ascorbic.csproj

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,11 @@
3838

3939
<PropertyGroup>
4040
<PackageReleaseNotes>
41-
- Addition: AsyncProducerConsumerQueue{T}
42-
- Addition: LogEventType
43-
- Addition: "Type" property in LogEventArgs
44-
- Addition: The ability to create and use a custom serializer for ConfigurationManager
45-
- Addition: 2 Built-in ConfigurationSerializers (XML, and JSON)
46-
- Addition: Task.WithCancellation extension
47-
- Addition: Generated PolyType shapes for some other serializable types
48-
- Addition: StreamReader.ReadToEndAsync(CancellationToken)
49-
- Modified: Improved cancellation support for some extension methods.
50-
- Modified: Make use of MEF for the add-in manager
51-
- Modified: Use JSON as the default format for ConfigurationManager
52-
- Modified: The AridityTeam.Logging.Logger class is now inherited from DisposableObject
53-
- Modified: Log event listeners will trigger upon a new listener has been registered or removed from the logger
54-
- Removed: The "OnLogMessageEvent(object?, LogMessageEventArgs)" function in AridityTeam.Logging.ILogEventListener
41+
IMPORTANT: A different version format will be used after this version (0.0.9)
42+
43+
- Modified: README contents
44+
- Modified: Removed the dependency for System.Reflection.DispatchProxy
45+
- Modified: Removed the dependency for System.IO.Compression
5546
</PackageReleaseNotes>
5647
</PropertyGroup>
5748

@@ -61,15 +52,13 @@
6152

6253
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0' Or '$(TargetFramework)' == 'net472'">
6354
<PackageReference Include="Nullable" />
64-
<PackageReference Include="System.Reflection.DispatchProxy" />
6555
<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" />
6656
<PackageReference Include="Microsoft.Bcl.Memory" />
6757
<PackageReference Include="Microsoft.Bcl.HashCode" />
6858
<PackageReference Include="System.Text.Json" />
6959
</ItemGroup>
7060
<ItemGroup Condition="'$(TargetFramework)' == 'net472'">
7161
<PackageReference Include="System.Net.Http" />
72-
<PackageReference Include="System.IO.Compression" />
7362
</ItemGroup>
7463
<ItemGroup>
7564
<PackageReference Include="PolyType" />

0 commit comments

Comments
 (0)