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.

Sign up for GitHub

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

Update README.md #50

Closed
wants to merge 1 commit into from
Closed

Update README.md #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
59 changes: 57 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,57 @@
# cozystack-website
Cozystack.io website
# Cozystack 🌐

**Cozystack** is an open-source, cloud-native platform designed to simplify the management and deployment of custom cloud environments using **Kubernetes**. It offers seamless integration, high performance, and cost-efficiency, ideal for developers and organizations looking to scale applications with ease.

## 🚀 Features

- **Kubernetes-based infrastructure** 🛠️: Effortlessly deploy, manage, and scale applications.
- **Cost-Efficient** 💰: Maximize performance while optimizing resource utilization.
- **RESTful API**: Programmatic control over deployments and monitoring.
- **Open-Source**: Community-driven development with no vendor lock-in.
- **Pre-configured Monitoring** 📊: Built-in tools for tracking app performance.
- **Multi-Cloud Support** ☁️: Integrates with various cloud providers for flexibility.

---

## 📝 Installation

1. **Requirements**: Kubernetes, Docker, and Helm.
2. **Quick Install**:
```bash
curl -fsSL https://cozystack.io/install.sh | bash
Copy link
Member

Choose a reason for hiding this comment

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

It does not work like that, istallation is done using Talos Linux and appliying installation manifest to it.

```

3. **Documentation**: [Full Installation Guide](https://cozystack.io/docs/install)

---

## 🛠️ Usage

- **Deploying Apps**:
1. Navigate to the Cozystack dashboard.
2. Use the drag-and-drop feature or API to manage deployments.
Copy link
Member

@kvaps kvaps Oct 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

We have no drag-and-drop feature, it would be nice to provide a link to docs instead


- **Monitoring**:
- Access pre-configured dashboards for real-time performance metrics.
Comment on lines +28 to +35
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Good addition of the Usage section!

This section provides a quick overview of how to use Cozystack for deploying apps and monitoring.

Consider expanding on the deployment instructions slightly, perhaps mentioning any configuration files or environment setup needed before using the dashboard.

There's a minor indentation issue on line 35. It should be aligned with line 31 for consistency.

- **Monitoring**:
-    - Access pre-configured dashboards for real-time performance metrics.
+ **Monitoring**:
+   - Access pre-configured dashboards for real-time performance metrics.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## 🛠️ Usage
- **Deploying Apps**:
1. Navigate to the Cozystack dashboard.
2. Use the drag-and-drop feature or API to manage deployments.
- **Monitoring**:
- Access pre-configured dashboards for real-time performance metrics.
## 🛠️ Usage
- **Deploying Apps**:
1. Navigate to the Cozystack dashboard.
2. Use the drag-and-drop feature or API to manage deployments.
- **Monitoring**:
- Access pre-configured dashboards for real-time performance metrics.
🧰 Tools
🪛 Markdownlint

35-35: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


---

## 🎯 Why Cozystack?

- **Simplicity**: Minimal configuration needed to get started.
- **Flexibility**: Supports various cloud infrastructures without vendor constraints.
- **Community Focus**: Contributions and feedback help drive platform evolution.

---

## 🌍 Community & Support

- **Website**: [cozystack.io](https://cozystack.io)
- **Documentation**: [docs.cozystack.io](https://cozystack.io/docs)
- **Join the Community**: [Slack](https://slack.cozystack.io) | [GitHub](https://github.com/cozystack)

---

## 📜 License

Cozystack is licensed under the **MIT License**. See [LICENSE](https://cozystack.io/license) for more details.
Copy link
Member

Choose a reason for hiding this comment

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

Cozystack is Apache Licensed, link does not work