Skip to content

Commit cd9a59d

Browse files
committed
Update readme
1 parent 36ed38f commit cd9a59d

File tree

3 files changed

+59
-40
lines changed

3 files changed

+59
-40
lines changed

README.md

Lines changed: 55 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,57 @@
11
# Cloud-native .NET Core Kit
2+
23
[![Price](https://img.shields.io/badge/price-FREE-0098f7.svg)](https://github.com/cloudnative-netcore/netcorekit/blob/master/LICENSE)
34
[![version](https://img.shields.io/nuget/v/NetCoreKit.Domain.svg?label=version)](https://www.nuget.org/packages?q=NetCoreKit)
45
[![Build status](https://img.shields.io/appveyor/ci/thangchung/netcore-kit.svg)](https://ci.appveyor.com/api/project/thangchung/netcore-kit)
56

67
A set of cloud-native tools and utilities for .NET Core.
78

8-
<details>
9-
<summary>Features</summary>
9+
## Less code to get starting
1010

11-
- Simple libraries. No frameworks. Little abstraction.
12-
- Modular (Easy to swap out Utils, Domain, AspNetCore, Clean Architecture, Open API, Entity Framework Core, Event Bus...)
13-
- Adhere to [twelve-factor app paradigm](https://12factor.net) and more.
14-
- Resilience and health check out of the box.
15-
- Easy for configuration management.
16-
- Simply clean architecture supports.
17-
- Authentication/Authorization with OAuth 2.0 and OpenID Connect.
18-
- Clean and demystify error, debug logs.
19-
- API versioning from Docker container to WebAPI.
20-
- Documentation template with OpenAPI documentation.
21-
- Work natively with Kubernetes or even with Service Mesh.
11+
Small, lightweight, cloud-native out of the box, and much more simple to get starting with miniservices approach. [Why miniservices?](https://thenewstack.io/miniservices-a-realistic-alternative-to-microservices)
2212

23-
</details>
13+
- No data storage
2414

25-
## Less Code to Get Starting
15+
```csharp
16+
public class Startup
17+
{
18+
public void ConfigureServices(IServiceCollection services)
19+
{
20+
services.AddMiniService();
21+
}
2622

27-
Small, lightweight, cloud-native out of the box, and much more simple to get starting with miniservices approach. [Why miniservices?](https://thenewstack.io/miniservices-a-realistic-alternative-to-microservices)
23+
public void Configure(IApplicationBuilder app)
24+
{
25+
app.UseMiniService();
26+
}
27+
}
28+
```
29+
30+
- With Entity Framework
2831

2932
```csharp
3033
public class Startup
3134
{
3235
public void ConfigureServices(IServiceCollection services)
3336
{
34-
services.AddMiniService<TodoListDbContext>(
35-
svc =>
36-
{
37-
svc.AddEfSqlLiteDb();
38-
svc.AddExternalSystemHealthChecks();
39-
}
40-
);
37+
services.AddEfCoreMiniService<TodoListDbContext>(svc => svc.AddEfCoreMySqlDb());
38+
}
39+
40+
public void Configure(IApplicationBuilder app)
41+
{
42+
app.UseMiniService();
43+
}
44+
}
45+
```
46+
47+
- With MongoDb
48+
49+
```csharp
50+
public class Startup
51+
{
52+
public void ConfigureServices(IServiceCollection services)
53+
{
54+
services.AddMongoMiniService();
4155
}
4256

4357
public void Configure(IApplicationBuilder app)
@@ -48,21 +62,34 @@ public class Startup
4862
```
4963

5064
<details>
51-
<summary>More types of equipment to get starting</summary>
65+
<summary>More guidances to get starting</summary>
5266

5367
- Read [Get starting](https://github.com/cloudnative-netcore/netcorekit/wiki/Get-Started) section and [Play with Kubernetes](https://github.com/cloudnative-netcore/netcorekit/wiki/Deploy-on-k8s-on-local) section to know more about this cloud-native toolkit.
5468
- Basic usage can be found at [TodoApi Sample](https://github.com/cloudnative-netcore/netcorekit/tree/master/samples/TodoApi)
5569
- More advance usage is at [Coolstore Microservices](https://github.com/vietnam-devs/coolstore-microservices) project.
5670

5771
</details>
5872

59-
<details>
60-
<summary>Contributing</summary>
73+
### Features
74+
75+
- Simple libraries. No frameworks. Little abstraction.
76+
- Modular (Easy to swap out Utils, Domain, AspNetCore, Clean Architecture, Open API, Entity Framework Core, Event Bus...)
77+
- Adhere to [twelve-factor app paradigm](https://12factor.net) and more.
78+
- Resilience and health check out of the box.
79+
- Easy for configuration management.
80+
- Simply clean architecture supports.
81+
- Authentication/Authorization with OAuth 2.0 and OpenID Connect.
82+
- Clean and demystify error, debug logs.
83+
- API versioning from Docker container to WebAPI.
84+
- Documentation template with OpenAPI documentation.
85+
- Work natively with Kubernetes or even with Service Mesh.
86+
87+
More information about the number of features can be find at [List of features](https://github.com/cloudnative-netcore/netcorekit/wiki/Miniservice-template-guidance)
88+
89+
### Contributing
6190

6291
1. Fork it!
6392
2. Create your feature branch: `git checkout -b my-new-feature`
6493
3. Commit your changes: `git commit -am 'Add some feature'`
6594
4. Push to the branch: `git push origin my-new-feature`
6695
5. Submit a pull request :p
67-
68-
</details>

samples/BiMonetaryApi/appsettings.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@
1717
"ApiVersion": { "Enabled": true },
1818
"OpenApi": {
1919
"Enabled": true,
20-
"UI": {
21-
"Enabled": true
22-
},
20+
"UI": { "Enabled": true },
2321
"ApiInfo": {
2422
"Title": "BiMonetary API",
2523
"Description": "An application with Swagger, Swashbuckle, and API versioning.",

samples/TodoApi/appsettings.json

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,12 @@
2020
"ConnString": "server={0};port={1};uid={2};pwd={3};database={4}"
2121
}
2222
},
23-
"CleanArch": {
24-
"Enabled": true
25-
},
23+
"CleanArch": { "Enabled": true },
2624
"ApiVersion": { "Enabled": true },
2725
"OpenApi": {
2826
"Enabled": true,
29-
"UI": {
30-
"Enabled": true
31-
},
32-
"Profiler": {
33-
"Enabled": true
34-
},
27+
"UI": { "Enabled": true },
28+
"Profiler": { "Enabled": true },
3529
"ApiInfo": {
3630
"Title": "Todo APIs",
3731
"Description": "An application with Swagger, Swashbuckle, and API versioning.",

0 commit comments

Comments
 (0)