Skip to content

Commit 96c7427

Browse files
raghavyuvaraghavyuva
authored
docs: readme redesign (#400)
1 parent fd0233e commit 96c7427

File tree

1 file changed

+15
-94
lines changed

1 file changed

+15
-94
lines changed

‎README.md‎

Lines changed: 15 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,23 @@
1-
<div id="user-content-toc">
2-
<ul style="list-style: none;">
3-
<summary>
4-
<h1><samp>Nixopus</samp></h1><br>
5-
<h6>Streamline Your Entire Server Workflow — ServerOps with No Fuss</h6>
6-
<a href="https://nixopus.com"><img align="right" src="./assets/nixopus_logo_transparent.png" alt="Nixopus Logo" width="250" /></a>
7-
</summary>
8-
</ul>
1+
<div align="center">
2+
<img width="1800" height="520" alt="Heading(4)" src="https://github.com/user-attachments/assets/e103a9df-7abf-4f78-b75a-221331231247" />
93
</div>
104

11-
<samp>
12-
<table>
13-
<tr>
14-
<td>
15-
<a href="https://github.com/raghavyuva/nixopus/actions/workflows/security.yml">
16-
<img src="https://github.com/raghavyuva/nixopus/actions/workflows/security.yml/badge.svg" alt="Security Scan" />
17-
</a>
18-
<a href="https://github.com/raghavyuva/nixopus/actions/workflows/build_container.yml">
19-
<img src="https://github.com/raghavyuva/nixopus/actions/workflows/build_container.yml/badge.svg" alt="Package Manager" />
20-
</a>
21-
<a href="https://github.com/raghavyuva/nixopus/actions/workflows/release.yml">
22-
<img src="https://github.com/raghavyuva/nixopus/actions/workflows/release.yml/badge.svg" alt="Release" />
23-
</a>
24-
<br />
25-
<a href="https://www.youtube.com/watch?v=DrDGWNq4JM4">
26-
<img src="https://img.shields.io/youtube/views/DrDGWNq4JM4?style=social&label=View%20Demo" alt="YouTube Video Views" />
27-
</a>
28-
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/y/raghavyuva/nixopus">
29-
<img src="https://madewithlove.now.sh/in?heart=true&colorA=%23ff671f&colorB=%23046a38&text=India" alt="Made with love in India" />
30-
<br><br>
31-
<div align="center">
32-
<strong>
33-
<a href="https://nixopus.com"> Website</a> |
34-
<a href="https://docs.nixopus.com"> Documentation</a> |
35-
<a href="https://docs.nixopus.com/blog/"> Blogs</a>
36-
</strong>
37-
</div>
38-
<br>
39-
<p align="center">
40-
<a href="https://discord.gg/skdcq39Wpv" target="_blank">
41-
<img src="https://user-images.githubusercontent.com/31022056/158916278-4504b838-7ecb-4ab9-a900-7dc002aade78.png" alt="Join our Discord Community" width="200" style="border-radius: 12px; box-shadow: 0px 4px 12px rgba(0,0,0,0.15);" />
42-
</a>
43-
</p>
44-
</td>
45-
</tr>
46-
</table>
47-
</samp>
48-
49-
## Project Overview
50-
51-
Nixopus streamlines your workflow with comprehensive tools for deployment, monitoring, and maintenance.
525

53-
> ⚠️ **Important Note**: Nixopus is currently in alpha/pre-release stage and is not yet ready for production use. While you're welcome to try it out, we recommend waiting for the beta or stable release before using it in production environments. The platform is still undergoing testing and development.
6+
<p align="center">
7+
Open Source Server management platform with Terminal integration, and Self Hosting capabilities.
8+
</p>
9+
10+
<p align="center">
11+
<a href="https://nixopus.com"><b>Website</b></a> •
12+
<a href="https://docs.nixopus.com"><b>Documentation</b></a> •
13+
<a href="https://docs.nixopus.com/blog/"><b>Blog</b></a> •
14+
<a href="https://discord.gg/skdcq39Wpv"><b>Discord</b></a>
15+
</p>
5416

55-
## Demo / Screenshots
17+
<img width="1210" height="764" alt="image" src="https://github.com/user-attachments/assets/3f1dc1e0-956d-4785-8745-ed59d0390afd" />
5618

57-
| Self Host Stats | Team Display | File Manager |
58-
| :-: | :-: | :-: |
59-
| <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/28nkmy49nm7oi5tq1t8c.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/28nkmy49nm7oi5tq1t8c.webp" alt="Self Host Stats" /></a> | <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/gd5wei3oorzo6nwz96ro.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/gd5wei3oorzo6nwz96ro.webp" alt="Team Display" /></a> | <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/ikku6lr6cuqvv4ap5532.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/ikku6lr6cuqvv4ap5532.webp" alt="File Manager" /></a> |
6019

61-
| Self Host Logs | Dashboard Overview | Notification Preferences |
62-
| :-: | :-: | :-: |
63-
| <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/quinawz7qvb6b5czi7u9.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/quinawz7qvb6b5czi7u9.webp" alt="Self Host Logs" /></a> | <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/iu7s99nj347eb24b2sdz.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/iu7s99nj347eb24b2sdz.webp" alt="Dashboard Overview" /></a> | <a href="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/jtcayilnk5oeyy3qmcrp.webp"><img src="https://dev-to-uploads.s3.amazonaws.com/uploads/articles/jtcayilnk5oeyy3qmcrp.webp" alt="Notification Preferences" /></a> |
20+
> ⚠️ **Important Note**: Nixopus is currently in alpha/pre-release stage and is not yet ready for production use. While you're welcome to try it out, we recommend waiting for the beta or stable release before using it in production environments. The platform is still undergoing testing and development.
6421
6522
# Features
6623

@@ -90,14 +47,6 @@ curl -sSL https://install.nixopus.com | bash
9047
curl -sSL https://install.nixopus.com | bash -s -- --skip-nixopus-install
9148
```
9249

93-
### Self Host Nixopus on your VPS
94-
95-
Once the CLI is installed, you can self host Nixopus on your VPS:
96-
97-
```bash
98-
nixopus install
99-
```
100-
10150
#### Optional Parameters
10251

10352
You can customize your installation by providing the following optional parameters:
@@ -120,25 +69,7 @@ nixopus install \
12069
--timeout 600
12170
```
12271

123-
#### Installation with Options
124-
125-
You can also install the CLI and run `nixopus install` with options in a single command, refer [installation documentation](https://docs.nixopus.com/install/#installation-options) for more details on options:
126-
127-
```bash
128-
# Basic installation with verbose output
129-
curl -sSL https://install.nixopus.com | bash -s -- --verbose
130-
131-
# Installation with custom domains
132-
curl -sSL https://install.nixopus.com | bash -s -- --api-domain api.example.com --view-domain app.example.com
133-
134-
# Dry-run to see what would happen
135-
curl -sSL https://install.nixopus.com | bash -s -- --dry-run
136-
137-
# Install CLI only, skip nixopus install
138-
curl -sSL https://install.nixopus.com | bash -s -- --skip-nixopus-install
139-
```
140-
141-
Run `nixopus --help` to see all available commands.
72+
You can also install the CLI and run `nixopus install` with options in a single command, refer [installation documentation](https://docs.nixopus.com/install/#installation-options) for more details on options
14273

14374
## About the Name
14475

@@ -149,13 +80,3 @@ Nixopus is derived from the combination of "octopus" and the Linux penguin (Tux)
14980
<a href="https://github.com/raghavyuva/nixopus/graphs/contributors">
15081
<img src="https://contrib.rocks/image?repo=raghavyuva/nixopus" alt="Nixopus project contributors" />
15182
</a>
152-
153-
<!-- sponsors-start -->
154-
## 🎗️ Sponsors
155-
156-
| Avatar | Sponsor |
157-
| ------ | ------- |
158-
| [![](https://avatars.githubusercontent.com/u/47430686?u=4185ecc1ab0fb92dd3f722f0d3a34ed044de0aec&v=4&s=150)](https://github.com/shravan20) | [shravan20](https://github.com/shravan20) |
159-
160-
❤️ Thank you for your support!
161-
<!-- sponsors-end -->

0 commit comments

Comments
 (0)