diff --git a/README.md b/README.md index 18cf819..02115d7 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## About this project -This is the official CobalCore documentation. +This is the official CobaltChore documentation. ## Requirements and Setup @@ -16,20 +16,37 @@ This is the official CobalCore documentation. $ docker compose up -to bring up a auto-refreshable developoment version of the documentation. -The documentation is accessible via [http://localhost:5173/](). +Run the above command to bring up an auto-refreshable development version of +the documentation. The documentation is accessible via +[http://localhost:5173/](). ## Support, Feedback, Contributing -This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cobaltcore-dev/docs/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md). +This project is open to feature requests and suggestions, bug reports etc. via +[GitHub issues](https://github.com/cobaltcore-dev/docs/issues). Contribution +and feedback are encouraged and always welcome. For more information about how +to contribute, the project structure, as well as additional contribution +information, see our [Contribution Guidelines](CONTRIBUTING.md). ## Security / Disclosure -If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cobaltcore-dev/.github/blob/main/SECURITY.md) on how to report it. Please do not create GitHub issues for security-related doubts or problems. +If you find any bug that may be a security problem, please follow our +instructions at [in our security +policy](https://github.com/cobaltcore-dev/.github/blob/main/SECURITY.md) on how +to report it. Please do not create GitHub issues for security-related doubts or +problems. ## Code of Conduct -We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md) at all times. +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone. By participating in this +project, you agree to abide by its [Code of +Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md) +at all times. ## Licensing -Copyright 2025 SAP SE or an SAP affiliate company and CobaltCore contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cobaltcore-dev/docs). +Copyright 2025 SAP SE or an SAP affiliate company and CobaltCore contributors. +Please see our [LICENSE](LICENSE) for copyright and license information. +Detailed information including third-party components and their +licensing/copyright information is available [via the REUSE +tool](https://api.reuse.software/info/github.com/cobaltcore-dev/docs).