diff --git a/README.md b/README.md index 01a4855..6cf721b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,67 @@ # origin-community -This is a place where organizations and people that use [Origin Cloud](https://docs.origincloud.net)™ can [report bugs](https://github.com/provenant-dev/origin-community/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) or [security vulnerabilities](https://github.com/provenant-dev/origin-community/security/advisories/new), [request features](https://github.com/provenant-dev/origin-community/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=), and share knowledge and resources via a [wiki](https://github.com/provenant-dev/origin-community/wiki). +**Origin Cloud** is a zero-trust identity and workflow platform built on +[KERI](https://keri.one)-based cryptographic identifiers. +This repository is the public community hub for organizations and +individuals who *use* Origin Cloud — it is the right place to report +problems, request improvements, ask questions, and share resources. +It contains no application source code. -To contribute something here, please raise a pull request. Remember that in doing so, you are contributing public content that has CC-BY-SA 4.0 license. +--- +## How to participate + +| What you want to do | Where to go | +|---|---| +| Report a bug | [Open a bug report](https://github.com/provenant-dev/origin-community/issues/new?template=bug_report.md) | +| Report a security vulnerability | [Open a private security advisory](https://github.com/provenant-dev/origin-community/security/advisories/new) | +| Request a feature | [Open a feature request](https://github.com/provenant-dev/origin-community/issues/new?template=feature_request.md) | +| Ask a question or share a resource | [Use the wiki](https://github.com/provenant-dev/origin-community/wiki) | +| Browse or search known issues | [Issues list](https://github.com/provenant-dev/origin-community/issues) | + +## Contributing content + +Pull requests are welcome for any content in this repository (issue templates, +guides, and other in-repo files). By submitting a PR you agree that your +contribution is licensed under +[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) — the same +license that covers everything else in this repo. + +Steps: + +1. Fork the repository. +2. Create a branch with a short descriptive name (`fix/bug-template-wording`, + `add/getting-started-guide`, etc.). +3. Make your changes. +4. Open a pull request against `main` and describe what you changed and why. + +There is no build step and no test suite — this repo is documentation and +GitHub configuration only. + +## Repository layout + +``` +.github/ + ISSUE_TEMPLATE/ + bug_report.md # Template for bug reports + feature_request.md # Template for feature requests +LICENSE # CC BY 4.0 +README.md # This file +``` + +A `docs/` directory for richer guides and reference material is planned +and will appear here as the community grows. + +## Going deeper + +| Resource | Description | +|---|---| +| [Origin Cloud docs](https://docs.origincloud.net) | Official product documentation | +| [Wiki](https://github.com/provenant-dev/origin-community/wiki) | Community-maintained tips, examples, and Q&A | +| [Security policy](https://github.com/provenant-dev/origin-community/security/policy) | How to responsibly disclose vulnerabilities | + +## License + +All content in this repository is licensed under the +[Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/) +license. See [LICENSE](LICENSE) for the full text.