Skip to content
Open
Changes from all commits
Commits
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
113 changes: 111 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@

[![Static Badge](https://img.shields.io/badge/Stability-Nexus-228B22?style=for-the-badge&labelColor=FFC517)](https://stability.nexus/)

<!-- Correct deployed url to be added -->

</div>

<!-- Organization/Project Social Handles -->
Expand Down Expand Up @@ -48,6 +46,117 @@

<div align="center">
<h1>Info</h1>
<p><i>Legal and Informational Documents for Stability Nexus Projects</i></p>
</div>

## 📖 About

This repository contains essential legal and informational documents used across all **Stability Nexus** projects. These documents ensure transparency, legal compliance, and user awareness for decentralized applications built by The Stable Order.

## 📑 Table of Contents

- [About](#-about)
- [Repository Structure](#-repository-structure)
- [Documentation](#-documentation)
- [Usage](#-usage)
- [Contributing](#-contributing)
- [License](#-license)
- [Contact](#-contact)

## 📂 Repository Structure

```
Info/
├── KYA.md # Know Your Assumptions template
├── COPYRIGHT.md # Copyright notice and usage terms
├── TermsAndConditions.md # Terms and Conditions
├── Licenses/ # License documentation
├── public/ # Public assets (logos, images)
│ └── stability.svg # Stability Nexus logo
└── README.md # This file
```

## 📄 Documentation

### Core Documents

- **[Know Your Assumptions (KYA)](KYA.md)** - Template displayed on all Stability Nexus UIs to inform users about:
- Smart contract immutability and autonomy
- Blockchain transaction finality
- Serverless frontend architecture
- Risks and responsibilities
- Terms and conditions

- **[Copyright Information](COPYRIGHT.md)** - Copyright notice and usage terms for all works in this repository

- **[Terms and Conditions](TermsAndConditions.md)** - Detailed terms and conditions for using Stability Nexus applications

- **[Licenses](Licenses/)** - License documentation for the project

### Assets

- **[Public Assets](public/)** - Contains the Stability Nexus logo and other public resources

## 🔧 Usage

### For Developers

When building a Stability Nexus project, integrate the KYA modal:

1. Display `KYA.md` content as a modal on first use
2. Add a "KYA" link in the footer that reopens the modal
3. Require user acknowledgment before proceeding

**Example Implementation:**
- [Benefaction Platform (Ergo)](https://ergo.bene.stability.nexus)
- [Source Code](https://github.com/StabilityNexus/BenefactionPlatform-Ergo)

### For Users

These documents inform you about:
- How Stability Nexus applications work
- Your rights and responsibilities
- Risks associated with blockchain applications
- Terms of use

## 🤝 Contributing

We welcome contributions to improve our documentation! To contribute:

1. Fork this repository
2. Create a feature branch (`git checkout -b docs/improve-documentation`)
3. Make your changes
4. Commit with conventional format (`docs: improve KYA template`)
5. Push to your fork
6. Open a Pull Request

Please ensure:
- Documentation is clear and accurate
- Legal language is reviewed carefully
- Changes align with The Stable Order's mission

## 📜 License

All works in this repository may be used according to the conditions stated in the LICENSE.md file available in this repository.

These works are **WITHOUT ANY WARRANTY**, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

## 📞 Contact

- **Website:** [https://stability.nexus](https://stability.nexus)
- **Telegram:** [https://t.me/StabilityNexus](https://t.me/StabilityNexus)
- **Discord:** [https://discord.gg/YzDKeEfWtS](https://discord.gg/YzDKeEfWtS)
- **X (Twitter):** [@StabilityNexus](https://x.com/StabilityNexus)
- **Medium:** [https://news.stability.nexus](https://news.stability.nexus)
- **LinkedIn:** [Stability Nexus](https://linkedin.com/company/stability-nexus)
- **YouTube:** [@StabilityNexus](https://www.youtube.com/@StabilityNexus)

---

<div align="center">

© 2025 The Stable Order.

</div>

<p align="right">(<a href="#readme-top">back to top</a>)</p>