Skip to content

Commit 596fe6f

Browse files
committed
update readme
1 parent 431c285 commit 596fe6f

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,24 @@
33
<a href="https://sisk.proj.pw/" target="_blank"><img width="160" src="./.github/Icon.png"></a>
44
</p>
55
<h1>Sisk Framework</h1>
6-
6+
77
[Discover Sisk](https://www.sisk-framework.org/)
88
| [Documentation](https://docs.sisk-framework.org/)
99
| [Blog](https://blog.sisk-framework.org/)
1010
| [Changelogs](https://github.com/sisk-http/archive/tree/master/changelogs)
1111
| [Benchmarks](https://github.com/sisk-http/benchmarks)
12-
12+
1313
<div>
14-
14+
15+
<a href="">[![Tests](https://github.com/sisk-http/core/actions/workflows/dotnet-tests.yml/badge.svg)](https://github.com/sisk-http/core/actions/workflows/dotnet-tests.yml)</a>
1516
<a href="">[![Nuget](https://img.shields.io/nuget/dt/Sisk.HttpServer?logo=nuget)](https://www.nuget.org/packages/Sisk.HttpServer/)</a>
1617
<a href="">[![Nuget](https://img.shields.io/nuget/v/Sisk.HttpServer?label=last%20version)](https://www.nuget.org/packages/Sisk.HttpServer/)</a>
1718
<a href="">[![Nuget](https://img.shields.io/github/license/sisk-http/core)](https://github.com/sisk-http/core/blob/master/LICENSE.txt)</a>
1819
<a href="">[![Nuget](https://img.shields.io/badge/.net_version-8_|_9-purple?logo=dotnet)](#)</a>
1920
<a href="">[![Nuget](https://img.shields.io/badge/platform-win%20|%20unix%20|%20osx-orange.svg)](#)</a>
20-
21+
2122
</div>
22-
23+
2324
**Sisk** is a set of libraries for web development that is lightweight, agnostic, easy, simple, and robust. The perfect choice for your next project.
2425

2526
</div>
@@ -45,12 +46,10 @@ dotnet add package Sisk.HttpServer
4546

4647
In this repository, you have the source code of:
4748

48-
- [Sisk.HttpServer](src): the Sisk Framework mainframe and core functions.
49-
- [Sisk.SslProxy](extensions/Sisk.SslProxy): an experimental SSL proxy provider for Sisk.
50-
- [Sisk.IniConfiguration](extensions/Sisk.IniConfiguration): an INI-document configuration provider for Sisk.
51-
- [Sisk.BasicAuth](extensions/Sisk.BasicAuth): the basic authentication package which provides helper request handlers for handling authentication.
52-
- [Sisk.JsonRpc](extensions/Sisk.JsonRPC): this package provides an JSON-RPC 2.0 interface for Sisk projects.
53-
- [Sisk.Cadente](extensions/Sisk.Cadente): an experimental "ultrafast" implementation of the HTTP/1.1 protocol in pure C#.
49+
- [Sisk.HttpServer](src): the Sisk Framework mainframe and core functions.
50+
- [Sisk.IniConfiguration](extensions/Sisk.IniConfiguration): an INI-document configuration provider for Sisk.
51+
- [Sisk.BasicAuth](extensions/Sisk.BasicAuth): the basic authentication package which provides helper request handlers for handling authentication.
52+
- [Sisk.Cadente](extensions/Sisk.Cadente): an experimental "ultrafast" implementation of the HTTP/1.1 protocol in pure C#.
5453

5554
## Getting started
5655

@@ -61,20 +60,24 @@ Due to its explicit nature, its behavior is fully predictable. The main differen
6160
You can build applications that are not necessarily a complete web application, but that have an web module, such as receiving an OAuth authorization token, hosting a UI to control your application, monitoring logs, etc. Sisk is very flexible and abstract.
6261

6362
```c#
64-
using Sisk.Core.Http;
65-
6663
class Program
6764
{
6865
static async Task Main(string[] args)
6966
{
70-
using var app = HttpServer.CreateBuilder(5555).Build();
71-
67+
using var app = HttpServer.CreateBuilder()
68+
.UseListeningPort("http://localhost:5000/")
69+
.Build();
70+
7271
app.Router.MapGet("/", request =>
7372
{
74-
return new HttpResponse("Hello, world!");
73+
return new HttpResponse()
74+
{
75+
Status = 200,
76+
Content = new StringContent("Hello, world!")
77+
};
7578
});
76-
77-
await app.StartAsync(); // 🚀 app is listening on http://localhost:5555/
79+
80+
await app.StartAsync();
7881
}
7982
}
8083
```

0 commit comments

Comments
 (0)