Added README

This commit is contained in:
Stijn Bannink 2025-01-10 20:02:59 +01:00
parent 6f7f4e74c5
commit 7b6dd00f6c
Signed by: SBDeveloper
GPG key ID: B730712F2C3A9D7A
2 changed files with 72 additions and 0 deletions

21
LICENSE.md Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 SBDevelopment
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

51
README.md Normal file
View file

@ -0,0 +1,51 @@
# SBDocs
Welcome to **SBDocs**! This repository contains the documentation for SBDevelopment's plugins.
---
## 🤝 How to Contribute
We welcome contributions from developers and writers! Follow these steps to get started:
1. **Clone the repository**:
```bash
git clone https://git.sbdevelopment.tech/SBDevelopment/SBDocs.git
```
2. **Review the Contribution Guide**:
- Read our [Contribution Guidelines](./CONTRIBUTING.md) to understand the rules and standards for contributions.
3. **Change the Documentation**:
- Make your changes to the documentation.
- Ensure your changes are clear, concise, and free of errors.
4. **Submit a Pull Request**:
- Push your changes in a new branch.
- Create a Pull Request (PR).
---
## 📜 Licensing
All content in this repository is licensed under the **[MIT License](LICENSE.md)** unless otherwise noted. This ensures
the documentation is:
- Open for anyone to use, modify, and distribute.
- Maintained in compliance with standard open-source practices.
---
## 🛠️ Feedback and Issues
Have a question, suggestion, or spotted an issue? Let us know:
- Open a Git [Issue](https://git.sbdevelopment.tech/SBDevelopment/SBDocs/issues).
- Tag it appropriately (e.g., "Documentation Bug" or "Enhancement Request").
We value your feedback and aim to address issues promptly.
---
## 📬 Contact Us
For further assistance or collaboration inquiries:
- Join our [Discord Server](https://discord.gg/f8TzrdvW).