Skip to content
This repository was archived by the owner on Jun 30, 2021. It is now read-only.

Commit 19a79f1

Browse files
committed
Version/release notes set, README update
1 parent b911134 commit 19a79f1

2 files changed

Lines changed: 52 additions & 33 deletions

File tree

README.md

Lines changed: 46 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ _This project is a continuator of [AcspNet web-framework](https://github.com/i40
88

99
## Package status
1010

11-
| Latest version | [![Nuget version](http://img.shields.io/badge/nuget-v1.3-blue.png)](https://www.nuget.org/packages/Simplify.Web/) |
11+
| Latest version | [![Nuget version](http://img.shields.io/badge/nuget-v2.0-blue.png)](https://www.nuget.org/packages/Simplify.Web/) |
1212
| :------ | :------: |
1313
| **Dependencies** | [![NuGet Status](http://nugetstatus.com/Simplify.Web.png)](http://nugetstatus.com/packages/Simplify.Web) |
1414

@@ -20,34 +20,42 @@ _This project is a continuator of [AcspNet web-framework](https://github.com/i40
2020

2121
## Build status
2222

23-
| Branch | **.NET (4.5.2)** |
23+
| Branch | **.NET (4.6.2)** |
2424
| :------ | :------ |
2525
| **master** | [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/sln1ciuam2hobsv4/branch/master?svg=true)](https://ci.appveyor.com/project/i4004/simplify-web/branch/master) |
2626
| **develop** | [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/sln1ciuam2hobsv4/branch/develop?svg=true)](https://ci.appveyor.com/project/i4004/simplify-web/branch/develop) |
2727

2828
## Main features
2929

30+
* Comes as Microsoft.AspNetCore OWIN middleware
31+
* Can be used as an API backend only with other front-end frameworks
3032
* Based on MVC and MVVM patterns
31-
* Comes as OWIN middleware
33+
* Lightweigh & Fast
3234
* Uses switchable IOC container for itself and controllers, views constructor injection ([Simplify.DI](https://github.com/i4004/Simplify/wiki/Simplify.DI))
33-
* Mono-friendly
3435
* Support async controllers
35-
* Uses fast templates engine ([Simplify.Templates](https://github.com/i4004/Simplify/wiki/Simplify.Templates))
3636
* Supports controllers which can be run on any page
3737
* Localization-friendly (supports templates, string table and data files localization by default)
38+
* Uses fast templates engine ([Simplify.Templates](https://github.com/i4004/Simplify/wiki/Simplify.Templates))
3839
* Mocking-friendly
40+
* Mono-friendly
3941

4042
## Getting started
4143

42-
<!----To get started you can install [visual studio Simplify.Web project templates](http://visualstudiogallery.msdn.microsoft.com/25a4534d-5a5b-4cce-aecf-523c3679a1c3) and read [this](https://github.com/i4004/Simplify.Web/wiki/Getting-started) article.-->
44+
Below is the list of sample applications showing different variations of Simplify.Web usage
4345

44-
### The examples below shows simple backend HTML generation, but you can easily use any front end technologies with Simplify.Web like AngularJS etc.
46+
* [Only as an API backend with Angular + Bootstrap UI SPA](https://github.com/i4004/Simplify/tree/master/src/SampleApps/SampleApp.Angular)
47+
* [Very simple Kestrel-based Application with backend page](https://github.com/i4004/Simplify/tree/master/src/SampleApps/SampleApp.Kestrel)
48+
* [Kestrel-based Application with backend HTML generation, localization, authentication](https://github.com/i4004/Simplify/tree/master/src/SampleApps/SampleApp.SelfHosted)
49+
* [Only as an API backend with Vue.js + Bootstrap UI SPA](https://github.com/i4004/Simplify/tree/master/src/SampleApps/SampleApp.Vue)
50+
* [Only as an API backend with Vue.js + Element UI SPA](https://github.com/i4004/Simplify/tree/master/src/SampleApps/SampleApp.Vue.Element)
51+
* [Very simple Kestrel-based Application hosted as windows-service](https://github.com/i4004/Simplify/tree/master/src/SampleApps/SampleApp.WindowsServiceHosted)
4552

4653
[Getting started page](https://github.com/i4004/Simplify.Web/wiki/Getting-started)
4754

48-
## Some examples
55+
### Just some simple controllers example
4956

5057
#### Simple static page controller
58+
5159
```csharp
5260
// Controller will be executed only on HTTP GET request like http://mysite.com/about
5361
[Get("about")]
@@ -61,8 +69,37 @@ public class AboutController : Controller
6169
}
6270
```
6371

72+
#### API controller example
73+
74+
```csharp
75+
[Get("api/weatherTypes")]
76+
public class SampleDataController : Controller
77+
{
78+
private static readonly string[] Summaries =
79+
{
80+
"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
81+
};
82+
83+
public override ControllerResponse Invoke()
84+
{
85+
try
86+
{
87+
return new Json(items);
88+
}
89+
catch (Exception e)
90+
{
91+
Console.WriteLine(e);
92+
93+
return StatusCode(500);
94+
}
95+
}
96+
}
97+
```
98+
6499
#### Any page controller with high run priority example
100+
65101
Runs on any request and adds login panel to a pages
102+
66103
```csharp
67104
// Controller will be executed on any request and will be launched before other controllers (because they have Priority = 0 by default)
68105
[Priority(-1)]
@@ -80,6 +117,7 @@ public class LoginPanelController : AsyncController
80117
```
81118

82119
#### View example
120+
83121
```csharp
84122
public class LoggedUserPanelView : View
85123
{
@@ -96,27 +134,4 @@ public class LoggedUserPanelView : View
96134
}
97135
```
98136

99-
#### Templates example
100-
101-
##### Master.tpl
102-
```html
103-
<!DOCTYPE html>
104-
<html>
105-
<head>
106-
<title>{Title}</title>
107-
</head>
108-
<body>
109-
{MainContent}
110-
</body>
111-
</html>
112-
```
113-
114-
##### About.tpl
115-
116-
```html
117-
<div class="container">
118-
Welcome to about page!
119-
</div>
120-
```
121-
122137
### [Detailed documentation](https://github.com/i4004/Simplify.Web/wiki)

src/Simplify.Web/Simplify.Web.csproj

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<Product>Simplify</Product>
66
<Description>Lightweight and fast .NET web-framework based on MVC and OWIN</Description>
77
<Copyright>Licensed under LGPL</Copyright>
8-
<Version>2.0-pre02</Version>
8+
<Version>2.0</Version>
99
<PackageProjectUrl>https://github.com/i4004/Simplify.Web</PackageProjectUrl>
1010
<PackageIconUrl>https://raw.githubusercontent.com/i4004/Simplify.Web/master/Images/Icon.png</PackageIconUrl>
1111
<RepositoryUrl>https://github.com/i4004/Simplify.Web</RepositoryUrl>
@@ -18,11 +18,15 @@
1818
Other changes
1919
* .NET 4.5.2 version upgrade to .NET 4.6.2
2020
New Features
21-
.NET Standard 2.0 support
21+
* Microsoft.AspNetCore support with it's all features (SPA support, static files etc.)
22+
* .NET Standard 2.0 support
2223
* Status Code exact controller responses like Ok(), NoContent()
2324
* StatusCode controllers response
2425
* Controllers wrappers for main responses to shorten code without new keyword
2526
* Possibility to use Simplify.Web as a non-terminal middleware for SPA to only process API request and forward other requests to SPA server
27+
* Option to disable static files handling
28+
Bug fixes
29+
* Request empty relative path check fix
2630
</PackageReleaseNotes>
2731
<OutputPath>bin\Any CPU\$(Configuration)\</OutputPath>
2832
<DocumentationFile>bin\Any CPU\$(Configuration)\$(TargetFramework)\Simplify.Web.xml</DocumentationFile>

0 commit comments

Comments
 (0)