Skip to content

Commit f5996b1

Browse files
author
Andreas Gullberg Larsen
authored
Create UnitsNet.NuGet-README.md
For linking/importing into NuGet.org README section, until it is supported in .nuspec files.
1 parent ef9062d commit f5996b1

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

Docs/UnitsNet.NuGet-README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Units.NET
2+
3+
Everyone have written their share of trivial conversions - or less obvious ones where you need to Google that magic constant.
4+
5+
Stop littering your code with unnecessary calculations. Units.NET gives you all the common units of measurement and the conversions between them. It is light-weight, well-tested and portable.
6+
7+
## Installing
8+
9+
Run the following command in the [Package Manager Console](http://docs.nuget.org/docs/start-here/using-the-package-manager-console) or go to the [NuGet site](https://www.nuget.org/packages/UnitsNet/) for the complete relase history.
10+
11+
`Install-Package UnitsNet`
12+
13+
Build Targets:
14+
* .NET Standard 1.0
15+
* .NET 3.5 Client
16+
* [Windows Runtime Component](https://docs.microsoft.com/en-us/windows/uwp/winrt-components/) for UWP apps (JavaScript, C++ or C#)
17+
18+
Overview
19+
---
20+
* [50+ quantities with a total of 500+ units](UnitsNet/GeneratedCode/Enums) generated from [JSON](UnitsNet/UnitDefinitions/) by [Powershell scripts](UnitsNet/Scripts/GenerateUnits.ps1)
21+
* [1000+ unit tests](https://ci.appveyor.com/project/anjdreas/unitsnet) on conversions and localizations
22+
* Quantities as immutable structs that implement `IEquatable`, `IComparable`
23+
* [Static typing](#static-typing) to avoid ambiguous quantities or units
24+
* [Operator overloads](#operator-overloads) for arithmetic on quantities
25+
* [Extension methods](#extension-methods) for short-hand creation and conversions
26+
* [Parse and ToString()](#culture) supports cultures and localization
27+
* [Example: Creating a unit converter app](#example-app)
28+
* [Precision and accuracy](#precision)
29+
* [Serializable with JSON.NET](#serialization)
30+
* Extensible with [custom units](https://github.com/anjdreas/UnitsNet/wiki/Extending-with-Custom-Units)
31+
* [Contribute](#contribute) if you are missing some units
32+
* [Continuous integration](#ci) posts status reports to pull requests and commits
33+
* [Who are using this?](#who-are-using)

0 commit comments

Comments
 (0)