Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme.md #1179

Open
wants to merge 4 commits into
base: nightly
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 24 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,45 +5,44 @@
<h6>Orchestrate like never before. K8s reimagined.</h6>
<p align="center">
<a href="https://next-hat.com/nanocl"><b>Why</b></a> •
<a href="https://docs.next-hat.com/manuals/nanocl/install/overview"><b>Install</b></a> •
<a href="https://discord.gg/WV4Aac8uZg" target="_blank"><b>Discord</b></a> •
<a href="https://docs.next-hat.com/manuals/nanocl/install/overview"><b>Quickstart</b></a> •
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think the quick start should more point out to the getting started overview guide

<a href="https://x.com/next_hat" target="_blank"><b>𝕏</b></a>
</p>
<p>

[![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)

</p>
</div>

**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.<br/>
<blockquote>
<span>
You could build a K8s within Nanocl. But we are quite sure you wouldn't want to..
In a nutshell one could say we're solving known K8s memes.
</span>
</blockquote>

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.

## Quickstart

We are already compatible with **Linux**, **MacOS** & **Windows**, just jump to our [Installation guide][nanocl_install_guide].<br/>
Please bare with us, Nanocl is currently more than just on the cutting edge..

## Latest news

<blockquote>
<span>
Who said that K8s is more than a perfect platform for application workloads?
</span>
</blockquote>

## Installation

We are already compatible with **Linux**, **MacOS** & **Windows**, just jump to [Installation guide][nanocl_install_guide].<br/>
Please bare with us, Nanocl is currently more than just on the cutting edge..

## Latest news

- **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
Expand Down Expand Up @@ -84,6 +83,12 @@ Resources:

## Architecture

<blockquote>
<span>
You could build a K8s within Nanocl. But we are quite sure you wouldn't want to..
</span>
</blockquote>

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:

Expand Down Expand Up @@ -154,14 +159,16 @@ Please don't hesitate to **join our team** on [Discord][discord] if you have any
</blockquote>

Sponsors are **the ones who make this project possible**.<br/>
They help us to have the necessary resources for Nanocl to keep it alive and to improve it further.<br/>
They help us to have the necessary resources for Nanocl, so we're able to keep it alive & of course to improve it further.<br/>
If you want to **become a sponsor**, please use the GitHub Sponsor button.<br/>

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]*.<br/><br/>

**Our very kind sponsors:**
<p align="center">
<b>Our very kind sponsors</b>
</p>

<table>
<table align="center">
<tr>
<td align="center">
<a href="https://github.com/mamaicode">
Expand Down Expand Up @@ -198,6 +205,7 @@ People that sponsor us will have their **name** or **logo displayed here**, and
</td>
</tr>
</table>
<br/>

## Star History

Expand Down