From ae2ac1beeeb0d8ebf8b7d55e0adf0c010c448687 Mon Sep 17 00:00:00 2001 From: Daniel Werner <82284479+danielwernerio@users.noreply.github.com> Date: Sun, 1 Dec 2024 23:44:29 +0100 Subject: [PATCH 1/4] chore: update readme.md Optimizations: - Added a nice looking Discord badge - Improved K8s quotes (text & placement) Signed-off-by: Daniel Werner <82284479+danielwernerio@users.noreply.github.com> --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 007c0d83..58705c0d 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,7 @@
Orchestrate like never before. K8s reimagined.

Why • - Install • - Discord • + Quickstart • 𝕏

@@ -14,6 +13,7 @@ [![Tests](https://github.com/next-hat/nanocl/actions/workflows/tests.yml/badge.svg)](https://github.com/next-hat/nanocl/actions/workflows/tests.yml) [![Clippy](https://github.com/next-hat/nanocl/actions/workflows/clippy.yml/badge.svg)](https://github.com/next-hat/nanocl/actions/workflows/clippy.yml) [![codecov](https://codecov.io/gh/next-hat/nanocl/branch/nightly/graph/badge.svg?token=4I60HOW6HM)](https://codecov.io/gh/next-hat/nanocl) +[![Discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/WV4Aac8uZg)

@@ -25,25 +25,25 @@ The developing ecosystem provides an **easy** solution for **local** development The architecture of Nanocl enables a **seamless deployment** to **production** among other innovations.
- You could build a K8s within Nanocl. But we are quite sure you wouldn't want to.. + In a nutshell we're solving known K8s memes (among other things).
Nanocl will introduce the **next paradigm** for **Platform Engineers** by providing ground breaking cloud-native architectural innovations, best-in-class security, while reducing operational costs with e.g. 🦀 **Rust** based efficiency. -
- - Who said that K8s is more than a perfect platform for application workloads? - -
- -## Installation +## Quickstart We are already compatible with **Linux**, **MacOS** & **Windows**, just jump to [Installation guide][nanocl_install_guide].
Please bare with us, Nanocl is currently more than just on the cutting edge.. ## Latest news +
+ + Who said that K8s is more than a perfect platform for application workloads? + +
+ - **Blog**: [Automating deployment with GitHub Actions](https://docs.next-hat.com/blog/automating-deployment-with-github-actions-and-nanocl) on 24.11.2024 - **Release**: [End to End TLS encryption and first step for network meshing](https://docs.next-hat.com/blog/nanocl-0.16) on 01.11.2024 - **Release**: [Man page, Backup, Remove Orphans and more](https://docs.next-hat.com/blog/nanocl-0.15) on 11.06.2024 @@ -84,6 +84,12 @@ Resources: ## Architecture +
+ + You could build a K8s within Nanocl. But we are quite sure you wouldn't want to.. + +
+ Nanocl is designed as a **microservice** architecture, consisting of multiple components running as **containers**, including the **Nanocl Daemon** itself. The following components will be installed during `nanocl install` and are required to ensure full Nanocl functionalities: From 24a6f35dca490f4324793749b7e69112507d8bed Mon Sep 17 00:00:00 2001 From: Daniel Werner <82284479+danielwernerio@users.noreply.github.com> Date: Sun, 1 Dec 2024 23:49:18 +0100 Subject: [PATCH 2/4] chore: update readme.md Optimizations: - Minor: Grammar fix + Better sentence structure Signed-off-by: Daniel Werner <82284479+danielwernerio@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 58705c0d..323324a2 100644 --- a/README.md +++ b/README.md @@ -160,7 +160,7 @@ Please don't hesitate to **join our team** on [Discord][discord] if you have any Sponsors are **the ones who make this project possible**.
-They help us to have the necessary resources for Nanocl to keep it alive and to improve it further.
+They help us to have the necessary resources for Nanocl, so we're able to keep it alive & of course to improve it further.
If you want to **become a sponsor**, please use the GitHub Sponsor button.
People that sponsor us will have their **name** or **logo displayed here**, and will have access to a **special role** on our *[Discord][discord]*. From 09928ca304e060a81855b4eb1f18cca86ed7ed84 Mon Sep 17 00:00:00 2001 From: Daniel Werner <82284479+danielwernerio@users.noreply.github.com> Date: Mon, 2 Dec 2024 02:00:56 +0100 Subject: [PATCH 3/4] chore: update readme.md Optimizations: - Integrated some text based ideas from Leo's "solving-localhost-dev" repository - Improved K8s quote(s) - Minor stuff Signed-off-by: Daniel Werner <82284479+danielwernerio@users.noreply.github.com> --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 323324a2..e5dadae4 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,11 @@ **Nanocl** is an open source distributed system designed to revolutionize **cloud native** from the ground up. -The developing ecosystem provides an **easy** solution for **local** development, avoiding common issues like CORS & cookies when working with **complex microservices**. +The developing ecosystem provides an comprehensive solution for **localhost** development headache, avoiding common issues like CORS & cookies when working with **complex microservices**. It **reduces** infrastructure **complexity** while delivering **seamless deployment** to **production** among other innovations. -The architecture of Nanocl enables a **seamless deployment** to **production** among other innovations.
- In a nutshell we're solving known K8s memes (among other things). + In a nutshell one could say we're solving known K8s memes.
@@ -33,7 +32,7 @@ Nanocl will introduce the **next paradigm** for **Platform Engineers** by provid ## Quickstart -We are already compatible with **Linux**, **MacOS** & **Windows**, just jump to [Installation guide][nanocl_install_guide].
+We are already compatible with **Linux**, **MacOS** & **Windows**, just jump to our [Installation guide][nanocl_install_guide].
Please bare with us, Nanocl is currently more than just on the cutting edge.. ## Latest news From 115558697aedcfdba3caaace90e916e0af54055e Mon Sep 17 00:00:00 2001 From: Daniel Werner <82284479+danielwernerio@users.noreply.github.com> Date: Mon, 2 Dec 2024 02:21:17 +0100 Subject: [PATCH 4/4] chore: update readme.md - Improved design of the Sponsors section Signed-off-by: Daniel Werner <82284479+danielwernerio@users.noreply.github.com> --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e5dadae4..df9b65a2 100644 --- a/README.md +++ b/README.md @@ -162,11 +162,13 @@ Sponsors are **the ones who make this project possible**.
They help us to have the necessary resources for Nanocl, so we're able to keep it alive & of course to improve it further.
If you want to **become a sponsor**, please use the GitHub Sponsor button.
-People that sponsor us will have their **name** or **logo displayed here**, and will have access to a **special role** on our *[Discord][discord]*. +People that sponsor us will have their **name** or **logo displayed here**, and will have access to a **special role** on our *[Discord][discord]*.

-**Our very kind sponsors:** +

+ Our very kind sponsors +

- +
@@ -203,6 +205,7 @@ People that sponsor us will have their **name** or **logo displayed here**, and
+
## Star History