Skip to content

Commit

Permalink
adding more user friendly readme
Browse files Browse the repository at this point in the history
  • Loading branch information
orzklv committed Aug 14, 2024
1 parent f6bacab commit 057099f
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 2 deletions.
Binary file added .github/assets/footer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 51 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,51 @@
# orchestra
🎶 | Orchestrated everything included website builder
<p align="center">
<img src=".github/assets/header.png" alt="Uzinfocom's {Orchestra}">
</p>

<p align="center">
<h3 align="center">Website builder platform for ccTLD of .UZ</h3>
</p>

<p align="center">
<img align="center" src="https://img.shields.io/github/languages/top/uzinfocom-org/orchestra?style=flat&logo=nixos&logoColor=ffffff&labelColor=242424&color=242424" alt="Top Used Language">
<a href="https://t.me/uzinfocom_oss"><img align="center" src="https://img.shields.io/badge/Chat-grey?style=flat&logo=telegram&logoColor=ffffff&labelColor=242424&color=242424" alt="Telegram Channel"></a>
<a href="https://github.com/uzinfocom-org/orchestra/actions/workflows/test.yml"><img align="center" src="https://img.shields.io/github/actions/workflow/status/uzinfocom-org/orchestra/test.yml?style=flat&logo=github&logoColor=ffffff&labelColor=242424&color=242424" alt="Test CI"></a>
</p>

## About

It became trend to have website builder platforms in every ccTLDs. So, we decided to make our own platform for .UZ ccTLD. This project aims to provide a very convenient and easy-to-use website with a lot of features.
This project is a part of Uzinfocom RnD team (a.k.a ex Uzinfocom Open Source) projects.

## Features

- Convenient builder with good UX
- Automated deployment
- NS records management
- Automated programmable proxy
- Automated DNS management

## Building (WIP)

This section needs some attention

## Deployment (WIP)

This part also needs some attention

## Documents & Research

All researches and explorations conducted during the development of this project are available in the [docs](docs) directory. Specifically, [research.pdf](docs/research.pdf) contains the most important information about the project. It's actually exported from Orzklv's Apple Notes and contains personal notes as well.

## Thanks to contributors

- [Orzklv](https://github.com/orzklv)
- [Shakhzod Kudratov](https://github.com/shakhzodkudratov)

## License

This project is licensed under the MIT License - see the [LICENSE](license) file for details.

<p align="center">
<img src=".github/assets/footer.png" alt="Uzinfocom's {Orchestra}">
</p>
Binary file added docs/research.pdf
Binary file not shown.

0 comments on commit 057099f

Please sign in to comment.