diff --git a/README.md b/README.md index 46bdff5..ef0b84f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,128 @@ -# Solus -A unique social network with many tools +
+ +

+ Solus
+ We are the next generation social network in the WEB3. +
+

+logo + +
+

+ A privacy-focused, local-first, open-source, and ready-to-use.
+ 🔔Everything's easier with Solus +

+ +
+ +
+ +
+ Home Page | + Twitter | + Whitepaper +
+
+ +
+ +
+
+We are the next-generation social network that provides comfort, security and suitable for the requirements of any user in the Web3.. +
+
+ +## What is Solus + +In the rapidly evolving digital age, the intersection of blockchain technology and social networking has opened new avenues for decentralized applications, offering unprecedented security, transparency, and user empowerment. The Solus App emerges as a pioneering platform within this domain, built on the robust Blast blockchain. This whitepaper introduces the Solus, detailing its innovative approach to social networking through decentralized technologies and highlighting its potential to redefine online interactions. + +## The Need for Decentralization in Social Networking + +Traditional social networks are predominantly centralized, which often leads to significant concerns over privacy, data ownership, and transparency. Users frequently surrender control of their personal data to centralized entities that profit from their information without adequate compensation or privacy safeguards. Moreover, these platforms are susceptible to single points of failure, which can compromise user data and service availability. + +The Solus project was conceived to address these critical issues by leveraging the inherent benefits of blockchain technology, such as decentralization, immutability, and transparency, to create a new paradigm in social networking. + + +## The Blast Blockchain: A Foundation for Innovation + +The Solus App is built on the Blast blockchain, known for its high scalability, low transaction fees, and robust security features. The Blast blockchain utilizes a proof-of-stake (PoS) consensus mechanism, which not only ensures faster transactions but also significantly reduces the environmental impact compared to traditional proof-of-work systems. + +Utilizing this technology, the Solus provides a platform where all transactions, interactions, and data exchanges are recorded on the blockchain, ensuring a transparent, secure, and user-centric experience. + +## Contributing + +| Bug Reports | Feature Requests | Questions | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [Create a bug report](https://github.com/Solusweb3app/Solus/issues) | [Submit a feature request](https://github.com/Solusweb3app/Solus/issues/new?assignees=&labels=feat%2Cstory&projects=&template=FEATURE-REQUEST.yml&title=TITLE) | [Send us an Email](https://Solus.run) | | +| Something isn't working as expected | An idea for a new feature, or improvements | contact@Solus.run | + +Calling all developers, testers, tech writers and more! Contributions of all types are more than welcome, you can read more in [docs/types-of-contributions.md](docs/types-of-contributions.md). If you are interested in contributing code, read our [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) and feel free to check out our GitHub issues to get stuck in to show us what you’re made of. + +**Before you start contributing, please make sure you have read and accepted our Contributor License Agreement. To indicate your agreement, simply edit this file and submit a pull request.** + +For **bug reports**, **feature requests** and other **suggestions** you can also create a new issue and choose the most appropriate template for your feedback. + + + +If you have questions, you are welcome to contact us. One of the best places to get more info and learn more is in the [Solus](https://Solus.run) where you can engage with other like-minded individuals. + +## Ecosystem + +| Name | | | +| ------------------------------------------------ | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| [@Solus/component](packages/frontend/component) | Solus Component Resources | ![](https://img.shields.io/codecov/c/github/toeverything/affine?style=flat-square) | +| [@Solus/theme](packages/common/theme) | Solus theme | [![](https://img.shields.io/npm/dm/@toeverything/theme?style=flat-square&color=eee)](https://www.npmjs.com/package/@toeverything/theme) | + + +## Self-Host + +Begin with Docker to deploy your own feature-rich, unrestricted version of Solus. Our team is diligently updating to the latest version. For more information on how to self-host Solus, please refer to our [documentation](https://solus.run/). + +## Hiring + +Some amazing companies, including Solus, are looking for developers! Are you interested in joining Solus or its partners? Check out our Discord channel for some of the latest jobs available. + +## Email + +For questions and suggestions, please use this email [contact@solus.run] + +## Building + +### Codespaces + +From the GitHub repo main page, click the green "Code" button and select "Create codespace on master". This will open a new Codespace with the (supposedly auto-forked +Solus repo cloned, built, and ready to go. + +### Local + +See [BUILDING.md] for instructions on how to build Solus from source code. + +## Contributing + +We welcome contributions from everyone. +See [docs/contributing/tutorial.md](./docs/contributing/tutorial.md) for details. + +## Thanks + +Chromatic + +Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions. + +## License + +See [LICENSE] for details. + +[all-contributors-badge]: https://img.shields.io/github/contributors/toeverything/AFFiNE +[license]: ./LICENSE +[building.md]: ./docs/BUILDING.md +[update page]: https://affine.pro/blog?tag=Release%20Note +[jobs available]: ./docs/jobs.md +[latest packages]: https://github.com/toeverything/AFFiNE/pkgs/container/affine-self-hosted +[contributor license agreement]: https://github.com/toeverything/affine/edit/canary/.github/CLA.md +[rust-version-icon]: https://img.shields.io/badge/Rust-1.77.2-dea584 +[stars-icon]: https://img.shields.io/github/stars/toeverything/AFFiNE.svg?style=flat&logo=github&colorB=red&label=stars +[codecov]: https://codecov.io/gh/toeverything/affine/branch/canary/graphs/badge.svg?branch=canary +[node-version-icon]: https://img.shields.io/badge/node-%3E=18.16.1-success +[typescript-version-icon]: https://img.shields.io/github/package-json/dependency-version/toeverything/affine/dev/typescript +[react-version-icon]: https://img.shields.io/github/package-json/dependency-version/toeverything/AFFiNE/react?filename=packages%2Ffrontend%2Fcore%2Fpackage.json&color=rgb(97%2C228%2C251) +[blocksuite-icon]: https://img.shields.io/github/package-json/dependency-version/toeverything/AFFiNE/@blocksuite/store?color=6880ff&filename=packages%2Ffrontend%2Fcore%2Fpackage.json&label=blocksuite