Skip to content

Commit fc775d6

Browse files
committed
[fix] errors
1 parent c3bcdc9 commit fc775d6

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

index.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,38 @@
77
![Platform](https://img.shields.io/badge/platform-.NET%206.0%20%7C%20.NET%20Standard%202.1%20%7C%20.NET%20Standard%202.0-lightgrey)
88
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)](http://makeapullrequest.com)
99

10-
Framework can be used as:
10+
Simplify.Web is an open-source, lightweight, fast, and highly customizable server-side .NET web framework based on ASP.NET Core for building HTTP-based web applications, RESTful APIs, etc.
11+
12+
The framework can be used as:
1113

1214
- An API backend framework
13-
- As a mix of API backend + some SPA front end like Angular
14-
- As an old way backend generated web-site
15+
- A mix of API backend + SPA front end (e.g., Angular)
16+
- A traditional backend-generated website
1517

1618
Can be hosted:
1719

18-
- The same way as an ApsNetCore MVC application (On IIS, or as a console application)
19-
- Inside a windows service
20+
- The same way as an ASP.NET Core MVC application (on IIS or as a console application)
21+
- Inside a Windows service
2022

2123
## Main features
2224

2325
- Comes as Microsoft.AspNetCore middleware
2426
- Can be used as an API backend only with front-end frameworks
2527
- Based on MVC and MVVM patterns
26-
- Lightweight & Fast
27-
- Uses switchable IOC container for itself and controllers, views constructor injection ([Simplify.DI](https://github.com/SimplifyNet/Simplify/wiki/Simplify.DI))
28-
- Support async controllers
29-
- Supports controllers which can be run on any request
30-
- Localization-friendly (supports templates, strings and data files localization by default)
31-
- Uses fast templates engine ([Simplify.Templates](https://github.com/SimplifyNet/Simplify/wiki/Simplify.Templates))
28+
- Lightweight & fast
29+
- Uses a switchable IoC container for itself and controllers, views constructor injection ([Simplify.DI](https://github.com/SimplifyNet/Simplify/wiki/Simplify.DI))
30+
- Supports async controllers
31+
- Supports controllers which can run on any request
32+
- Localization-friendly (supports templates, strings, and data files localization by default)
33+
- Uses a fast template engine ([Simplify.Templates](https://github.com/SimplifyNet/Simplify/wiki/Simplify.Templates))
3234
- Mocking-friendly
3335
- Mono-friendly
3436

3537
## Quick start
3638

3739
There is a [templates package](https://github.com/SimplifyNet/Simplify.Web.Templates) available at nuget.org for Simplify.Web. It contains a couple of templates which can be a good starting point for your application.
3840

39-
Installing a templates package:
41+
Install the templates package:
4042

4143
```console
4244
dotnet new -i Simplify.Web.Templates
@@ -45,17 +47,17 @@ dotnet new -i Simplify.Web.Templates
4547
| Template | Short Name |
4648
| :---------------------------------- | :---------------------- |
4749
| Angular template | sweb.angular |
48-
| Api template | sweb.api |
50+
| API template | sweb.api |
4951
| Minimal template | sweb.minimal |
50-
| Windows service hosted api template | sweb.api.windowsservice |
52+
| Windows service hosted API template | sweb.api.windowsservice |
5153

52-
Use the short name to create a project based on selected template:
54+
Use the short name to create a project based on the selected template:
5355

5456
```console
5557
dotnet new sweb.angular -n HelloWorldApplication
5658
```
5759

58-
Then just run project via F5 (it will download all required nuget and npm packages at first build).
60+
Then just run the project via F5 (it will download all required NuGet and npm packages at the first build).
5961

6062
## [Detailed documentation](https://github.com/SimplifyNet/Simplify.Web/wiki)
6163

@@ -120,7 +122,7 @@ public class SampleModel
120122
}
121123
```
122124

123-
### Some simple HTML generation controllers example
125+
### Simple HTML generation controllers example
124126

125127
#### Static page controller v1 example
126128

@@ -139,7 +141,7 @@ public class AboutController : Controller
139141

140142
#### Any page controller v1 with high run priority example
141143

142-
Runs on any request and adds login panel to a pages
144+
Runs on any request and adds a login panel to pages.
143145

144146
```csharp
145147
// Controller will be executed on any request and will be launched before other controllers (because they have Priority = 0 by default)
@@ -180,11 +182,11 @@ public class LoggedUserPanelView : View
180182
Below is the list of sample applications showing different variations of Simplify.Web usage:
181183

182184
- [Only as an API backend with Angular + Bootstrap UI SPA](https://github.com/SimplifyNet/Simplify.Web/tree/master/src/SampleApps/SampleApp.Angular)
183-
- [Kestrel-based Application with backend HTML generation, localization, authentication](https://github.com/SimplifyNet/Simplify.Web/tree/master/src/SampleApps/SampleApp.Classic)
185+
- [Kestrel-based application with backend HTML generation, localization, authentication](https://github.com/SimplifyNet/Simplify.Web/tree/master/src/SampleApps/SampleApp.Classic)
184186

185187
![Simplify](https://raw.githubusercontent.com/SimplifyNet/Simplify.Web/master/images/screenshots/sample-app-classic.png)
186188

187-
- [Simple Kestrel-based Application hosted as windows-service](https://github.com/SimplifyNet/Simplify.Web/tree/master/src/SampleApps/SampleApp.WindowsServiceHosted)
189+
- [Simple Kestrel-based application hosted as a Windows service](https://github.com/SimplifyNet/Simplify.Web/tree/master/src/SampleApps/SampleApp.WindowsServiceHosted)
188190

189191
## Contributing
190192

@@ -207,9 +209,9 @@ Additional extensions to Simplify.Web live in their own repositories on GitHub.
207209
- [Simplify.Web.Postman](https://github.com/SimplifyNet/Simplify.Web.Postman) - Postman collection and environment generation
208210
- [Simplify.Web.Swagger](https://github.com/SimplifyNet/Simplify.Web.Swagger) - Swagger generation for controllers
209211
- [Simplify.Web.Multipart](https://github.com/SimplifyNet/Simplify.Web.Multipart) - multipart form model binder
210-
- [Simplify.Web.MessageBox](https://github.com/SimplifyNet/Simplify.Web.MessageBox) - non-interactive server side message box
211-
- [Simplify.Web.Templates](https://github.com/SimplifyNet/Simplify.Web.Templates) - .NET projects templates
212+
- [Simplify.Web.MessageBox](https://github.com/SimplifyNet/Simplify.Web.MessageBox) - non-interactive server-side message box
213+
- [Simplify.Web.Templates](https://github.com/SimplifyNet/Simplify.Web.Templates) - .NET project templates
212214

213215
## License
214216

215-
Licensed under the GNU LESSER GENERAL PUBLIC LICENSE
217+
Licensed under the GNU LESSER GENERAL PUBLIC LICENSE.

0 commit comments

Comments
 (0)