Skip to content

Commit

Permalink
Update README.md with new sections: next, quick start, etc
Browse files Browse the repository at this point in the history
  • Loading branch information
equisoide committed Mar 8, 2020
1 parent e0f149a commit cfbd48f
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,35 @@
# .NET Core Utility Library: *Celerik.NetCore.Util*
# .NET Core Utility Library

![build](https://github.com/celerik/celerik-netcore-util/workflows/build/badge.svg?branch=master&event=push)
![deploy](https://github.com/celerik/celerik-netcore-util/workflows/deploy/badge.svg)
[![build](https://github.com/celerik/celerik-netcore-util/workflows/build/badge.svg?branch=master&event=push)](https://github.com/celerik/celerik-netcore-util/actions?query=workflow%3Abuild)
[![deploy](https://github.com/celerik/celerik-netcore-util/workflows/deploy/badge.svg)](https://github.com/celerik/celerik-netcore-util/actions?query=workflow%3Adeploy)
[![Coverage Status](https://coveralls.io/repos/github/celerik/celerik-netcore-util/badge.svg?branch=master)](https://coveralls.io/github/celerik/celerik-netcore-util?branch=master)
[![NuGet](https://img.shields.io/nuget/v/Celerik.NetCore.Util.svg)](http://www.nuget.org/packages/Celerik.NetCore.Util/)

## What's it

**Celerik.NetCore.Util** provides some custom utilities for .NET Core projects, including: attributes, azure, datetime, exceptions, files, json, pagination, resources, testing, convertions, crypto, enums, queries, stack trace, strings, validations.
*Celerik.NetCore.Util* provides some custom utilities for .NET Core projects, including: attributes, azure, datetime, exceptions, files, json, pagination, resources, testing, convertions, crypto, enums, queries, stack trace, strings, validations.

## What's next

Check out the road map of *Celerik.NetCore.Util* [here](ROADMAP.md).

## Quick Start

```
PM > Install-Package Celerik.NetCore.Util
```

## How to Contribute
Check out the contributing guide [here](CONTRIBUTING.md).

## License

*Celerik.NetCore.Util* is licensed under the [MIT license](LICENSE).

## Celerik.NetCore.Util project

`master` is the default branch accepting Pull Requests. It releases a package everytime the `head_commit.message` contains the word `[release]`.

## Blog and examples

Check out Celerik's website [here](http://celerik.com).

0 comments on commit cfbd48f

Please sign in to comment.