philipp/uncloud
1
0
Fork 0
mirror of https://github.com/psviderski/uncloud.git synced 2026-08-26 11:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README: Django tutorial, project status, reformat

Browse Source
This commit is contained in:
Pasha Sviderski
2026-04-23 20:41:20 +10:00
parent 45cf87a0cb
commit cd07278858
1 changed files with 17 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -10
View File
@@ -100,7 +100,10 @@ platform, whether you're running on a $5 VPS, a spare Mac mini, or a rack of bar
curl -fsS https://get.uncloud.run/install.sh | sh curl -fsS https://get.uncloud.run/install.sh | sh
``` ```
See [Installation](https://uncloud.run/docs/getting-started/install-cli) for more options. There's also a [nightly rolling release](https://github.com/psviderski/uncloud/releases/tag/nightly) available if you want to try the latest features and fixes before they're included in an official release. See [Installation](https://uncloud.run/docs/getting-started/install-cli) for more options.
There's also a [nightly rolling release](https://github.com/psviderski/uncloud/releases/tag/nightly) available if you
want to try the latest features and fixes before they're included in an official release.
2. Initialise your first machine: 2. Initialise your first machine:
@@ -283,18 +286,24 @@ machine is a full backup of your control plane.
## 🧪 Interactive tutorials ## 🧪 Interactive tutorials
To give you a chance to play with Uncloud without even leaving your browser, we're providing interactive tutorials and playgrounds on the [iximiuz Labs](https://labs.iximiuz.com/) platform. To give you a chance to play with Uncloud without even leaving your browser, we're providing interactive tutorials and
playgrounds on the [iximiuz Labs](https://labs.iximiuz.com/) platform.
Available tutorials: Available tutorials:
1. [Setting up a new Uncloud cluster](https://labs.iximiuz.com/tutorials/uncloud-create-cluster-ebebf72b) - the tutorial walks you through creating a new cluster with two machines and then deploying a simple web service to it. 1. [Setting up a new Uncloud cluster](https://labs.iximiuz.com/tutorials/uncloud-create-cluster-ebebf72b) - the tutorial
walks you through creating a new cluster with two machines and then deploying a simple web service to it.
2. [Deploying a Django web application](https://labs.iximiuz.com/tutorials/uncloud-deploy-django-app-7a378bc3) - deploy
a Django web app from source code to a remote Linux server using Uncloud.
You can also launch the [Uncloud playground](https://labs.iximiuz.com/playgrounds/uncloud-cluster-64523f7c) where you can play with an already initialized Uncloud cluster. You can also launch the [Uncloud playground](https://labs.iximiuz.com/playgrounds/uncloud-cluster-64523f7c) where you
can play with an already initialized Uncloud cluster.
## 🏗 Project status ## 🏗 Project status
Uncloud is currently in active development and is **not ready for production use**. Features may change significantly Uncloud is under active development and pre-1.0, so expect occasional breaking changes between releases. The core build,
and there may be breaking changes between releases. push, and deploy workflows are stable, and much of the runtime relies on battle-tested projects: Docker, Caddy,
WireGuard, and Corrosion.
We'd love your input! Here's how you can contribute: We'd love your input! Here's how you can contribute:
@@ -332,8 +341,8 @@ SQLite database used to share Uncloud's cluster state.
* Join our [Discord server](https://discord.gg/eR35KQJhPu) for real-time discussions, support, and updates. * Join our [Discord server](https://discord.gg/eR35KQJhPu) for real-time discussions, support, and updates.
* Follow [@psviderski](https://x.com/psviderski) on X/Twitter. * Follow [@psviderski](https://x.com/psviderski) on X/Twitter.
* Subscribe to [my newsletter](https://uncloud.run/#subscribe) to follow the progress, get early insights into new * Subscribe to [our newsletter](https://uncloud.run/#subscribe) to follow the journey of building Uncloud: progress
features, and be the first to know when it's ready for production use. updates, user stories, and the occasional deep dive.
* Watch this repository for releases. * Watch this repository for releases.
## 💖 Sponsors ## 💖 Sponsors
@@ -351,8 +360,6 @@ These companies and projects are helping Uncloud with their generous sponsorship
<img alt="Trendshift" src="https://trendshift.io/api/badge/repositories/14069" /> <img alt="Trendshift" src="https://trendshift.io/api/badge/repositories/14069" />
</a> </a>
Thank you [@cedws](https://github.com/cedws) for being the first contributor to Uncloud! 🎉
<a href="https://github.com/psviderski/uncloud/graphs/contributors"> <a href="https://github.com/psviderski/uncloud/graphs/contributors">
<img src="https://contrib.rocks/image?repo=psviderski/uncloud" /> <img src="https://contrib.rocks/image?repo=psviderski/uncloud" />
</a> </a>