yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added contributing.md and improved README.md

Browse Source
This commit is contained in:
Qubasa
2023-10-31 12:57:28 +01:00
parent 3e7a866ea1
commit 974f594a78
2 changed files with 217 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -1,9 +1,23 @@
# clan.lol core
# cLAN Core Repository
This is the monorepo of the clan.lol project
In here are all the packages we use, all the nixosModules we use/expose, the CLI and tests for everything.
Welcome to the cLAN Core Repository, the heart of the [clan.lol](https://clan.lol/) project! This monorepo houses all the essential packages, NixOS modules, CLI tools, and tests you need to contribute and work with the cLAN project.
## cLAN config tool
## Getting Started
- The quickstart guide can be found here: [here](/clan/clan-core/src/branch/main/docs/quickstart.md)
- Find the docs [here](/clan/clan-core/src/branch/main/docs/clan-config.md)
If you're new to cLAN and eager to dive in, start with our quickstart guide:
- **Quickstart Guide**: Check out [quickstart.md](docs/quickstart.md) to get up and running with cLAN in no time.
## Managing Secrets
Security is paramount, and cLAN provides guidelines for handling secrets effectively:
- **Secrets Management**: Learn how to manage secrets securely by reading [secrets-management.md](docs/secrets-management.md).
## Contributing to cLAN
We welcome contributions from the community, and we've prepared a comprehensive guide to help you get started:
- **Contribution Guidelines**: Find out how to contribute and make a meaningful impact on the cLAN project by reading [contributing.md](docs/contributing.md).
Whether you're a newcomer or a seasoned developer, we look forward to your contributions and collaboration on the cLAN project. Let's build amazing things together!