From 0d8e7017578850d79e1c0dc1fe271bada74f34c9 Mon Sep 17 00:00:00 2001 From: Jose Quintana Date: Sun, 31 Oct 2021 12:40:09 +0100 Subject: [PATCH] docs: minor description improvements [skip ci] --- README.md | 18 ++++++++++-------- docs/content/migration.md | 2 +- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 466cafe..e2fa54a 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ +## Overview + **Static Web Server** (or **`SWS`** abbreviated) is a very small and fast production-ready web server suitable to serve static web files or assets. It is focused on **lightness and easy to use** principles but keeping [high performance and safety](https://blog.rust-lang.org/2015/04/10/Fearless-Concurrency.html) powered by [The Rust Programming Language](https://rust-lang.org). @@ -54,20 +56,20 @@ It's cross-platform and available for `Linux`, `macOS`, `Windows` and `FreeBSD` - Ability to accept a socket listener as a file descriptor for use in sandboxing and on-demand applications (E.g [systemd](http://0pointer.de/blog/projects/socket-activation.html)). - Cross-platform. Binaries available for Linux, macOS, Windows & FreeBSD x86_64 / ARM. +## Documentation + +For more details about the API, usage and examples please have a look at [The Documentation Website](https://sws.joseluisq.net/). + ## Releases -- [Docker Hub Images](https://hub.docker.com/r/joseluisq/static-web-server/) +- [Docker Images](https://hub.docker.com/r/joseluisq/static-web-server/) - [Release Binaries](https://github.com/joseluisq/static-web-server/releases) -- [Platforms/Architectures supported](https://sws.joseluisq.net/platforms-architectures/) +- [Platforms/Architectures Supported](https://sws.joseluisq.net/platforms-architectures/) -### Notes +## Notes - If you're looking for `v1` please go to [1.x](https://github.com/joseluisq/static-web-server/tree/1.x) branch. -- If you want to migrate from `v1` to `v2` please take a look at [v2.0.0](https://github.com/joseluisq/static-web-server/releases/tag/v2.0.0) release. - -## Documentation - -For API, usage and examples see the [full documentation website](https://sws.joseluisq.net/). +- If you want to migrate from `v1` to `v2` please take a look at [Migrating from `v1` to `v2`](https://sws.joseluisq.net/migration/) release. ## Contributions diff --git a/docs/content/migration.md b/docs/content/migration.md index a9113e2..441c040 100644 --- a/docs/content/migration.md +++ b/docs/content/migration.md @@ -1,4 +1,4 @@ -# Migration from v1 to v2 +# Migrating from v1 to v2 The `v2` introduces notable changes including new features, performance improvements and new targets support like ARM64 and OSes like FreeBSD. -- libgit2 1.7.2