From 43cda03087b7fba6a7b5813ddc240006d1074f59 Mon Sep 17 00:00:00 2001 From: CypherPotato Date: Mon, 26 Feb 2024 10:32:53 -0300 Subject: [PATCH] update readmes --- .nuget/README.html | 426 ++++++++++++++++++++++++++++++++++++++++--- .nuget/README.md | 20 +- README.md | 2 +- src/Sisk.Core.csproj | 4 +- 4 files changed, 412 insertions(+), 40 deletions(-) diff --git a/.nuget/README.html b/.nuget/README.html index 667c139..c9346e6 100644 --- a/.nuget/README.html +++ b/.nuget/README.html @@ -1,47 +1,425 @@ -

Sisk is a web development framework that is lightweight, agnostic, easy, simple, and robust. The perfect choice for your next project.

+ + + + + + + + + + + + + + + + +

Sisk is a web development framework that is lightweight, agnostic, easy, simple, and robust. The perfect choice for your next project.

-

Documentation

-

You can get started with Sisk here or build the documentation repository here.

+

Documentation

+

You can get started with Sisk here or build the documentation repository here.

For information about release notes, changelogs and API breaking changes, see docs/Changelog.md.

-

Getting started

The Sisk core idea is to create a service that runs on the internet and follows the pattern you define. Moreover, Sisk is a framework that adapts to how you want it to work, not the other way around.

Due to its explicit nature, its behavior is predictable. The main differentiator from ASP.NET is that Sisk can be up and running in very few lines of code, avoiding unnecessary configurations, and requiring the minimum setup to get your server working. Additionally, it does not demand any additional .NET SDK packages to develop, as the base package of .NET 6 is sufficient to start your development with Sisk.

It can handle multiple requests asynchronously, provides useful tools to manage and accelerate web development.

-
using Sisk.Core.Http;
-using Sisk.Core.Routing;
+
using Sisk.Core.Http;
+using Sisk.Core.Routing;
 
-namespace myProgram;
+namespace myProgram;
 
-class Program
+class Program
 {
-    static void Main(string[] args)
-    {
-        var app = HttpServer.CreateBuilder();
+    static void Main(string[] args)
+    {
+        var app = HttpServer.CreateBuilder();
 
-        app.Router += new Route(RouteMethod.Get, "/", request =>
+        app.Router += new Route(RouteMethod.Get, "/", request =>
         {
-            return new HttpResponse(200)
-                .WithContent("Hello, world!");
+            return new HttpResponse(200)
+                .WithContent("Hello, world!");
         });
 
         app.Start();
     }
 }
-

+

Main features

-

Sisk can do web development the way you want. Create MVC, MVVC, SOLID applications, or any other design pattern you're interested in.

+

Sisk can do web development the way you want. Create MVC, MVVC, SOLID applications, or any other design pattern you're interested in.

-

Why use Sisk?

-

Sisk is a highly modular and sustainable framework designed for creating a variety of applications, including Restful applications, gRPC, Websockets, file servers, GraphQL, Entity Framework, and more. Its development is ongoing, with a focus on simplicity, easy maintenance, and an enjoyable experience for developers. Sisk is known for its efficiency, even in low-performance environments, and it can handle over twenty thousand requests per second. The framework is compatible with any machine supporting .NET, including those that do not require Native AOT. Sisk also offers additional implementations and packages for extended functionality.

-

While Sisk draws inspiration from ASP.NET, it aims for simpler and more performant development without the need for installing additional components. It provides a straightforward and robust development model, allowing developers to handle requests efficiently and explicitly. Sisk simplifies HTTP-related tasks and offers comprehensive documentation and open-source access to its source code, making it accessible and easy to learn for web developers.

+

Read More

+

Read more about Sisk at it's repository or website.

+ + + diff --git a/.nuget/README.md b/.nuget/README.md index 6e476d0..fc7e16d 100644 --- a/.nuget/README.md +++ b/.nuget/README.md @@ -1,20 +1,16 @@ **Sisk** is a **web development framework** that is lightweight, agnostic, easy, simple, and robust. The perfect choice for your next project. - [Discover Sisk](https://sisk.project-principium.dev/) -- [Documentation](https://sisk.project-principium.dev/read?q=/contents/docs/welcome.md) -- [Changelog](https://github.com/sisk-http/docs/tree/master/archive) -- [Specification](https://sisk.project-principium.dev/read?q=/contents/spec/index.md) -- [Benchmark](https://github.com/sisk-http/benchmarks) -- [Roadmap](https://github.com/orgs/sisk-http/projects/1) +- [Documentation](https://md.proj.pw/sisk-http/docs-v2/main) +- [Changelogs](https://github.com/sisk-http/archive/tree/master/changelogs) +- [Benchmarks](https://github.com/sisk-http/benchmarks) -### Documentation +## Documentation -You can get started with Sisk [here](https://sisk.project-principium.dev/read?q=/contents/docs/getting-started.md) or build the documentation repository [here](https://github.com/sisk-http/docs). +You can get started with Sisk [here](https://md.proj.pw/sisk-http/docs-v2/main/) or build the documentation repository [here](https://github.com/sisk-http/docs-v2). For information about release notes, changelogs and API breaking changes, see [docs/Changelog.md](https://github.com/sisk-http/docs/blob/master/Changelog.md). -## Getting started - The Sisk core idea is to create a service that runs on the internet and follows the pattern you define. Moreover, Sisk is a framework that adapts to how you want it to work, not the other way around. Due to its explicit nature, its behavior is predictable. The main differentiator from ASP.NET is that Sisk can be up and running in very few lines of code, avoiding unnecessary configurations, and requiring the minimum setup to get your server working. Additionally, it does not demand any additional .NET SDK packages to develop, as the base package of .NET 6 is sufficient to start your development with Sisk. @@ -52,8 +48,6 @@ Sisk can do web development the way you want. Create MVC, MVVC, SOLID applicatio - **Open-source:** the entire Sisk ecosystem is open source, and all the libraries and technologies we use must be open source as well. Sisk is entirely distributed under the MIT License, which allows the commercial development. - **Sustainable:** you are the one who makes the project, Sisk gives you the tools. Because it is open source, the community (including you) can maintain, fix bugs and improve Sisk over time. -## Why use Sisk? - -Sisk is a highly modular and sustainable framework designed for creating a variety of applications, including Restful applications, gRPC, Websockets, file servers, GraphQL, Entity Framework, and more. Its development is ongoing, with a focus on simplicity, easy maintenance, and an enjoyable experience for developers. Sisk is known for its efficiency, even in low-performance environments, and it can handle over twenty thousand requests per second. The framework is compatible with any machine supporting .NET, including those that do not require Native AOT. Sisk also offers additional implementations and packages for extended functionality. +## Read More -While Sisk draws inspiration from ASP.NET, it aims for simpler and more performant development without the need for installing additional components. It provides a straightforward and robust development model, allowing developers to handle requests efficiently and explicitly. Sisk simplifies HTTP-related tasks and offers comprehensive documentation and open-source access to its source code, making it accessible and easy to learn for web developers. \ No newline at end of file +Read more about Sisk at it's [repository](https://github.com/sisk-http/) or [website](https://sisk.project-principium.dev/). \ No newline at end of file diff --git a/README.md b/README.md index 3d2acf1..79e7e30 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ [![Nuget](https://img.shields.io/github/license/sisk-http/core)](https://github.com/sisk-http/core/blob/master/LICENSE.txt) [![Nuget](https://img.shields.io/badge/.net%20version-%206%20|%207%20|%208-purple.svg?logo=dotnet)](#) [![Nuget](https://img.shields.io/badge/platform-win%20|%20unix%20|%20osx-orange.svg)](#) - + **Sisk** is a **web development framework** that is lightweight, agnostic, easy, simple, and robust. The perfect choice for your next project. diff --git a/src/Sisk.Core.csproj b/src/Sisk.Core.csproj index d7ba7b7..09c8931 100644 --- a/src/Sisk.Core.csproj +++ b/src/Sisk.Core.csproj @@ -8,7 +8,7 @@ symbols.nupkg True embedded - + Library disable enable @@ -43,7 +43,7 @@ $(MSBuildProjectDirectory)\$(IntermediateOutputPath)=. - +