diff --git a/README.md b/README.md index 51daf4c0..12a4e0f1 100755 --- a/README.md +++ b/README.md @@ -15,16 +15,12 @@ The platform to hold all your creative. > πŸ‘‹ We have a official beta instance, you can access it from [https://comty.app](https://comty.app) -## Special Sponsors -[![Plenix Network - Cheap Hosting Solutions](https://storage.ragestudio.net/comty-static-assets/sponsors/plenix_board.png)](https://plenix.net) - - -## 🌟 Some of features -πŸš€ Real-time updates are provided to users about various activities such as new followers, likes, posts, comments, and more, thanks to a bid event engine that uses websockets. - +## 🌟 Some of the features πŸ“ A microblogging system similar to Twitter allows users to post short messages with attachments and more. -πŸŽ₯ Comty TV is a live video streaming feature that allows users to stream their videos, events, or anything else in real-time to other users. It provides playback anywhere, including HLS, RTMP, FLV, and WebRTC, without vendor lock-in. +πŸŽ₯ Comty TV is a live video streaming feature that allows users to stream their videos, events, or anything else in real-time to other users. It provides "playback anywhereβ„’" URL's, including HLS, RTMP, RTSP without vendor lock-in. + +> Now supports restreams! Easily push your streams to whatever you want. 🎢 Comty Music lets users publish their music masterpieces, share their playlists with other users, and synchronize their music with other platforms. A powerful music player is also included in the application. @@ -33,52 +29,36 @@ The platform to hold all your creative. ## 🌐 Available platforms We have official public services that you can find on these platforms! -🌐 Web |Β [https://comty.app](https://comty.app) - -πŸ“± Android APK (unsigned) (bundle auto update) | [https://github.com/ragestudio/comty/releases/download/0.50.4/app-release.apk](https://github.com/ragestudio/comty/releases/download/0.50.4/app-release.apk) +🌐 Web | [https://comty.app](https://comty.app) +πŸ“± (Outdated) Android APK (unsigned) (bundle auto update) | [https://github.com/ragestudio/comty/releases/download/0.50.4/app-release.apk](https://github.com/ragestudio/comty/releases/download/0.50.4/app-release.apk) ## πŸš€ Development -### Prerequisites -For local development you will need to have installed some tools: +Check the [getting-started.md](./docs/development/getting-started.md) document to get started with the development. -- Install Node.js (v18 or higher) [manualy](https://nodejs.org/en/download/) or use [nvm](https://github.com/nvm-sh/nvm) tool (or similar tools). +## 🀝 Contributions +Contributions to Comty are welcome. If you want to contribute, please follow the instructions mentioned in the [CONTRIBUTING.md](./CONTRIBUTING.md) file. -- (Recomended) Use [npm](https://docs.npmjs.com/cli/v11/configuring-npm/install) package manager. +## πŸ’… Code Style +Please read the related document [CODE_STYLE.md](./CODE_STYLE.md) for more details. -- (Optional) Install [Docker](https://docs.docker.com/get-docker/), used for building and deployment. +## πŸ§‘β€πŸ’» Code of Conduct +We provide a [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) file to help you understand what behavior is expected and unacceptable in the project. -### Setup -- Getting the repository -```shell -git clone --recurse-submodules https://github.com/ragestudio/comty && cd comty -``` +## πŸ“œ License +Comty is licensed under the Comty license. See the [LICENSE](./LICENSE) file for more details. -- Installing all dependencies -```shell -npm install -``` - -### Starting the development server -- You can use the command `npm run dev` to start all development servers. -```shell -npm run dev -``` - -## πŸ§‘β€πŸ’» Status +## πŸ§‘β€πŸ”¬ Status The project is in alpha design phase, and the development is slow but continuous, prioritizing quality to ensure the project base is preserved for a long time. > πŸ‘₯ The Comty team is looking for new members, and any contribution to the project is very welcome. > If you are interested in more depth in the project, you can join our [Discord server](https://discord.gg/yxQR6EXf2F) and talk to us. -## 🀝 Contributions -Contributions to Comty are welcome. If you want to contribute, please follow the instructions mentioned in the CONTRIBUTING.md file. - -## πŸ“œ License -Comty is licensed under the Comty license. See the LICENSE file for more details. - ## :heart: Thanks to our supporters + +## Special Sponsors +[![Plenix Network - Cheap Hosting Solutions](https://storage.ragestudio.net/comty-static-assets/sponsors/plenix_board.png)](https://plenix.net)